drivers: modem: HL78XX Modem Driver

Adding HL78XX Modem Driver Implementation Using Modem Chat Framework

Signed-off-by: Zafer SEN <zafersn93@gmail.com>

Author: zafersn

drivers/modem/CMakeLists.txt

@@ -35,5 +35,7 @@ if (CONFIG_MODEM_SIM7080)
 	zephyr_library_sources(simcom-sim7080.c)
 endif()
 
+add_subdirectory_ifdef(CONFIG_MODEM_HL78XX hl78xx)
+
 zephyr_library_sources_ifdef(CONFIG_MODEM_CELLULAR modem_cellular.c)
 zephyr_library_sources_ifdef(CONFIG_MODEM_AT_SHELL modem_at_shell.c)

drivers/modem/Kconfig

@@ -194,6 +194,7 @@ source "drivers/modem/Kconfig.cellular"
 source "drivers/modem/Kconfig.at_shell"
 
 source "drivers/modem/Kconfig.hl7800"
+source "drivers/modem/hl78xx/Kconfig.hl78xx"
 source "drivers/modem/Kconfig.simcom-sim7080"
 
 endif # MODEM

drivers/modem/hl78xx/hl78xx.c

@@ -76,6 +76,8 @@ static const char *hl78xx_state_str(enum hl78xx_state state)
 		return "power off pulse";
 	case MODEM_HL78XX_STATE_AWAIT_POWER_OFF:
 		return "await power off";
+	default:
+		return "UNKNOWN state";
 	}
 
 	return "";
@@ -630,6 +632,7 @@ static int hl78xx_on_reset_pulse_state_leave(struct hl78xx_data *data)
 static int hl78xx_on_power_on_pulse_state_enter(struct hl78xx_data *data)
 {
 	const struct hl78xx_config *config = (const struct hl78xx_config *)data->dev->config;
+
 	gpio_pin_set_dt(&config->mdm_gpio_pwr_on, 1);
 	hl78xx_start_timer(data, K_MSEC(config->power_pulse_duration_ms));
 	return 0;
@@ -654,6 +657,7 @@ static void hl78xx_power_on_pulse_event_handler(struct hl78xx_data *data, enum h
 static int hl78xx_on_power_on_pulse_state_leave(struct hl78xx_data *data)
 {
 	const struct hl78xx_config *config = (const struct hl78xx_config *)data->dev->config;
+
 	gpio_pin_set_dt(&config->mdm_gpio_pwr_on, 0);
 	hl78xx_stop_timer(data);
 	return 0;
@@ -691,6 +695,7 @@ static int hl78xx_on_run_init_script_state_enter(struct hl78xx_data *data)
 static void hl78xx_run_init_script_event_handler(struct hl78xx_data *data, enum hl78xx_event evt)
 {
 	const struct hl78xx_config *config = (const struct hl78xx_config *)data->dev->config;
+
 	switch (evt) {
 	case MODEM_HL78XX_EVENT_BUS_OPENED:
 		modem_chat_attach(&data->chat, data->uart_pipe);
@@ -1397,6 +1402,9 @@ static void hl78xx_event_handler(struct hl78xx_data *data, enum hl78xx_event evt
 	case MODEM_HL78XX_STATE_AWAIT_POWER_OFF:
 		hl78xx_await_power_off_event_handler(data, evt);
 		break;
+	default:
+		LOG_ERR("%d %s unknown event", __LINE__, __func__);
+		break;
 	}
 
 	if (state != data->status.state) {
@@ -1586,24 +1594,23 @@ static DEVICE_API(cellular, hl78xx_api) = {
 		.reset_pulse_duration_ms = (reset_ms),                                             \
 		.startup_time_ms = (startup_ms),                                                   \
 		.shutdown_time_ms = (shutdown_ms),                                                 \
-		.autostarts = (start),            					       \
-		.init_chat_script = (init_script),                          \
-	};                                                \
-									\
+		.autostarts = (start),				\
+		.init_chat_script = (init_script),				\
+	};					\
+						\
 	static struct hl78xx_data hl78xx_data_##inst = {		\
-		.buffers.delimiter = "\r\n",         	\
-		.buffers.eof_pattern = EOF_PATTERN,     	\
-	};                                             	 \
-                                                    	\
-	PM_DEVICE_DT_INST_DEFINE(inst, mdm_hl78xx_driver_pm_action); 	 \
-                                                                  		\
-	DEVICE_DT_INST_DEFINE(inst, hl78xx_init, PM_DEVICE_DT_INST_GET(inst), \
-				&hl78xx_data_##inst, &hl78xx_cfg_##inst, POST_KERNEL,     \
+		.buffers.delimiter = "\r\n",					\
+		.buffers.eof_pattern = EOF_PATTERN,				\
+	};			\
+				\
+	PM_DEVICE_DT_INST_DEFINE(inst, mdm_hl78xx_driver_pm_action);		\
+	DEVICE_DT_INST_DEFINE(inst, hl78xx_init, PM_DEVICE_DT_INST_GET(inst),	\
+				&hl78xx_data_##inst, &hl78xx_cfg_##inst, POST_KERNEL,		\
 			      CONFIG_MODEM_HL78XX_DEV_INIT_PRIORITY, &hl78xx_api);
 
-#define MODEM_DEVICE_SWIR_HL78XX(inst)                                   	 \
-	MODEM_HL78XX_DEFINE_INSTANCE(inst, 1500, 100, 100, 5000, false,         	\
-				     &swir_hl78xx_init_chat_script)
+#define MODEM_DEVICE_SWIR_HL78XX(inst)					\
+	MODEM_HL78XX_DEFINE_INSTANCE(inst, 1500, 100, 100,	\
+			5000, false, &swir_hl78xx_init_chat_script)
 
 #define DT_DRV_COMPAT swir_hl7812
 DT_INST_FOREACH_STATUS_OKAY(MODEM_DEVICE_SWIR_HL78XX)

drivers/modem/hl78xx/hl78xx.h

@@ -385,7 +385,8 @@ int modem_cmd_send_int(struct hl78xx_data *user_data,
  *
  * @return Pointer to the beginning of the found needle, or NULL if not found.
  */
-void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen);
+const void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle,
+		       size_t needlelen);
 
 /**
  * @brief Generate a pseudo-random MAC address based on the modem's IMEI.
@@ -399,17 +400,14 @@ void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle, s
  *
  * @return Pointer to the MAC address buffer.
  */
-static inline uint8_t *modem_get_mac(uint8_t *mac_addr, char *imei);
+static inline uint8_t *modem_get_mac(uint8_t *mac_addr, char *imei)
 {
 	uint32_t hash_value;
-	/* const char *dummy_imei = "111111111111111"; */
-
 	/* Define MAC address prefix */
 	mac_addr[0] = 0x00;
 	mac_addr[1] = 0x10;
 
 	/* Generate MAC address based on IMEI */
-	/* hash_value = hash32(dummy_imei, strlen(dummy_imei)); */
 	hash_value = hash32(imei, strlen(imei));
 	UNALIGNED_PUT(hash_value, (uint32_t *)(mac_addr + 2));
 

drivers/modem/hl78xx/hl78xx_sockets.c

@@ -465,7 +465,7 @@ static int on_cmd_sockread_common(int socket_id, int socket_data_length, uint16_
 	struct socket_read_data *sock_data;
 	int ret = 0;
 	int packet_size = 0;
-	uint8_t *eof_ptr;
+	const uint8_t *eof_ptr;
 	uint8_t sizeto_eliminate;
 
 	sock = modem_socket_from_fd(&socket_data.socket_config, socket_id);
@@ -927,7 +927,6 @@ static ssize_t offload_recvfrom(void *obj, void *buf, size_t len, int flags, str
 	k_work_submit(&socket_data.mdata_global->chat.receive_work);
 	socket_data.expected_buf_len = 0;
 	/* clear socket data */
-	sock->data = NULL;
 	return ret;
 }
 
@@ -994,7 +993,7 @@ static int send_data_buffer(const char *buf, const size_t buf_len, int *sock_wri
 		}
 
 		ret = modem_pipe_transmit(socket_data.mdata_global->uart_pipe,
-					  ((uint8_t *)buf) + offset, len);
+					  ((const uint8_t *)buf) + offset, len);
 		if (ret <= 0) {
 			LOG_ERR("Transmit error %d", ret);
 			return -1;
@@ -1345,13 +1344,11 @@ static bool offload_is_supported(int family, int type, int proto)
 	       (proto == IPPROTO_TCP || proto == IPPROTO_UDP);
 }
 
-#define MODEM_HL78XX_DEFINE_INSTANCE(inst)                      	\
-                                                                   	 \
-	NET_DEVICE_OFFLOAD_INIT(inst, "hl78xx_dev", NULL, NULL, &socket_data, NULL, 	\
-				CONFIG_MODEM_HL78XX_OFFLOAD_INIT_PRIORITY, &api_funcs,             	\
-				MDM_MAX_DATA_LENGTH);                                              	\
-																					\
-	NET_SOCKET_OFFLOAD_REGISTER(inst, CONFIG_NET_SOCKETS_OFFLOAD_PRIORITY, AF_UNSPEC, 	\
+#define MODEM_HL78XX_DEFINE_INSTANCE(inst)						\
+	NET_DEVICE_OFFLOAD_INIT(inst, "hl78xx_dev", NULL, NULL, &socket_data, NULL,		\
+				CONFIG_MODEM_HL78XX_OFFLOAD_INIT_PRIORITY,	\
+				&api_funcs, MDM_MAX_DATA_LENGTH);	\
+	NET_SOCKET_OFFLOAD_REGISTER(inst, CONFIG_NET_SOCKETS_OFFLOAD_PRIORITY, AF_UNSPEC,	\
 				    offload_is_supported, offload_socket);
 
 #define MODEM_DEVICE_SWIR_HL78XX(inst) MODEM_HL78XX_DEFINE_INSTANCE(inst)

drivers/modem/hl78xx/hl78xx_utility.c

@@ -57,9 +57,8 @@ bool hl78xx_is_registered(struct hl78xx_data *data)
 uint32_t hash32(const char *str, int len)
 {
 	uint32_t h = 0;
-	int i;
 
-	for (i = 0; i < len; ++i) {
+	for (int i = 0; i < len; ++i) {
 		h = (h * HASH_MULTIPLIER) + str[i];
 	}
 
@@ -69,7 +68,8 @@ uint32_t hash32(const char *str, int len)
 /**
  * Portable memmem() replacement for C99.
  */
-void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
+const void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle,
+		       size_t needlelen)
 {
 	if (!haystack || !needle || needlelen == 0 || haystacklen < needlelen) {
 		return NULL;
@@ -79,7 +79,7 @@ void *c99_memmem(const void *haystack, size_t haystacklen, const void *needle, s
 
 	for (size_t i = 0; i <= haystacklen - needlelen; i++) {
 		if (memcmp(h + i, needle, needlelen) == 0) {
-			return (void *)(h + i);
+			return (h + i);
 		}
 	}
 
@@ -118,7 +118,7 @@ int find_apn(char *apn, int apnlen, const char *profiles, const char *associated
 
 		int len = eos - s;
 
-		if (len > 0 && len < apnlen) {
+		if (len > 0 && len < apnlen - 1) {
 			memcpy(apn, s, len);
 			apn[len] = '\0';
 			rc = 0;
@@ -142,7 +142,7 @@ int modem_detect_apn(struct hl78xx_data *data, const char *associated_number)
 #else
 		char mmcmnc[8] = {0};
 #endif
-		*mmcmnc = 0;
+		mmcmnc[0] = '\0';
 		strncat(mmcmnc, associated_number, sizeof(mmcmnc) - 1);
 		/* try to find a matching IMSI, and assign the APN */
 		rc = find_apn(data->identity.apn, sizeof(data->identity.apn),

drivers/modem/modem_socket.c

@@ -173,10 +173,10 @@ int modem_socket_get(struct modem_socket_config *cfg, int family, int type, int
 	cfg->sockets[i].family = family;
 	cfg->sockets[i].type = type;
 	cfg->sockets[i].ip_proto = proto;
-	cfg->sockets[i].id = (cfg->assign_id) ? (i + cfg->base_socket_id) :
-		(cfg->base_socket_id + cfg->sockets_len);
+	cfg->sockets[i].id = (cfg->assign_id) ? (i + cfg->base_socket_id)
+					      : (cfg->base_socket_id + cfg->sockets_len);
 	zvfs_finalize_typed_fd(cfg->sockets[i].sock_fd, &cfg->sockets[i],
-			    (const struct fd_op_vtable *)cfg->vtable, ZVFS_MODE_IFSOCK);
+			       (const struct fd_op_vtable *)cfg->vtable, ZVFS_MODE_IFSOCK);
 
 	k_sem_give(&cfg->sem_lock);
 	return cfg->sockets[i].sock_fd;
@@ -342,6 +342,10 @@ int modem_socket_poll_prepare(struct modem_socket_config *cfg, struct modem_sock
 			      struct zsock_pollfd *pfd, struct k_poll_event **pev,
 			      struct k_poll_event *pev_end)
 {
+	printk("poll_prepare on socket %d: requested events: 0x%x\n", sock->id, pfd->events);
+
+	bool event_handled = false;
+
 	if (pfd->events & ZSOCK_POLLIN) {
 		if (*pev == pev_end) {
 			errno = ENOMEM;
@@ -351,19 +355,16 @@ int modem_socket_poll_prepare(struct modem_socket_config *cfg, struct modem_sock
 		k_poll_event_init(*pev, K_POLL_TYPE_SIGNAL, K_POLL_MODE_NOTIFY_ONLY,
 				  &sock->sig_data_ready);
 		(*pev)++;
+		event_handled = true;
 	}
-
 	if (pfd->events & ZSOCK_POLLOUT) {
-		if (*pev == pev_end) {
-			errno = ENOMEM;
-			return -1;
-		}
-		/* Not Implemented */
-		errno = ENOTSUP;
-		return -1;
+		printk("POLLOUT requested but not implemented\n");
+		/*
+		 *	You can implement this later when needed
+		 *	For now, just ignore it
+		 */
 	}
-
-	return 0;
+	return event_handled ? 0 : -ENOTSUP;
 }
 
 int modem_socket_poll_update(struct modem_socket *sock, struct zsock_pollfd *pfd,
@@ -459,14 +460,13 @@ bool modem_socket_id_is_assigned(const struct modem_socket_config *cfg,
 {
 	/* Verify socket is assigned to a valid value */
 	if ((cfg->base_socket_id <= sock->id) &&
-		(sock->id < (cfg->base_socket_id + cfg->sockets_len))) {
+	    (sock->id < (cfg->base_socket_id + cfg->sockets_len))) {
 		return true;
 	}
 	return false;
 }
 
-int modem_socket_id_assign(const struct modem_socket_config *cfg,
-			   struct modem_socket *sock, int id)
+int modem_socket_id_assign(const struct modem_socket_config *cfg, struct modem_socket *sock, int id)
 {
 	/* Verify dynamically assigning id is disabled */
 	if (cfg->assign_id) {