driver: modem: gsm_ppp: Use DTS

Author: ycsin

drivers/modem/Kconfig.gsm

@@ -1,4 +1,5 @@
 # Copyright (c) 2020 Intel Corporation
+# Copyright (c) 2021 G-Technologies Sdn. Bhd.
 # SPDX-License-Identifier: Apache-2.0
 
 config MODEM_GSM_PPP
@@ -29,8 +30,6 @@ config MODEM_GSM_SIMCOM
 
 endchoice
 
-config MODEM_GSM_UART_NAME
-	string "UART device name the modem is connected to"
 
 config MODEM_GSM_RX_STACK_SIZE
 	int "Size of the stack allocated for receiving data from modem"

drivers/modem/gsm_ppp.c

@@ -4,6 +4,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+#define DT_DRV_COMPAT gsm_ppp
 
 #include <logging/log.h>
 LOG_MODULE_REGISTER(modem_gsm, CONFIG_MODEM_LOG_LEVEL);
@@ -29,6 +30,8 @@ LOG_MODULE_REGISTER(modem_gsm, CONFIG_MODEM_LOG_LEVEL);
 #include <time.h>
 #endif
 
+#define GSM_UART_DEV_ID                 DT_INST_BUS(0)
+#define GSM_UART_DEV_NAME               DT_INST_BUS_LABEL(0)
 #define GSM_CMD_READ_BUF                128
 #define GSM_CMD_AT_TIMEOUT              K_SECONDS(2)
 #define GSM_CMD_SETUP_TIMEOUT           K_SECONDS(6)
@@ -1067,7 +1070,7 @@ static void mux_setup(struct k_work *work)
 {
 	struct gsm_modem *gsm = CONTAINER_OF(work, struct gsm_modem,
 					     gsm_configure_work);
-	const struct device *uart = device_get_binding(CONFIG_MODEM_GSM_UART_NAME);
+	const struct device *uart = DEVICE_DT_GET(GSM_UART_DEV_ID);
 	int ret;
 
 	/* We need to call this to reactivate mux ISR. Note: This is only called
@@ -1226,7 +1229,7 @@ void gsm_ppp_start(const struct device *dev)
 
 	/* Re-init underlying UART comms */
 	int r = modem_iface_uart_init_dev(&gsm->context.iface,
-				device_get_binding(CONFIG_MODEM_GSM_UART_NAME));
+					  DEVICE_DT_GET(GSM_UART_DEV_ID));
 	if (r) {
 		LOG_ERR("modem_iface_uart_init returned %d", r);
 		return;
@@ -1303,7 +1306,7 @@ static int gsm_init(const struct device *dev)
 	gsm->gsm_data.rx_rb_buf_len = sizeof(gsm->gsm_rx_rb_buf);
 
 	r = modem_iface_uart_init(&gsm->context.iface, &gsm->gsm_data,
-				device_get_binding(CONFIG_MODEM_GSM_UART_NAME));
+				DEVICE_DT_GET(GSM_UART_DEV_ID));
 	if (r < 0) {
 		LOG_DBG("iface uart error %d", r);
 		return r;

drivers/net/ppp.c

@@ -862,7 +862,7 @@ static int ppp_start(const struct device *dev)
 
 		dev_name = mux->name;
 #elif IS_ENABLED(CONFIG_MODEM_GSM_PPP)
-		dev_name = CONFIG_MODEM_GSM_UART_NAME;
+		dev_name = DT_BUS_LABEL(DT_INST(0, gsm_ppp));
 #else
 		dev_name = CONFIG_NET_PPP_UART_NAME;
 #endif

dts/bindings/modem/gsm-ppp.yaml

@@ -0,0 +1,13 @@
+# Copyright (c) 2021 G-Technologies Sdn. Bhd.
+# SPDX-License-Identifier: Apache-2.0
+
+description: GSM PPP modem
+
+compatible: "gsm,ppp"
+
+include: uart-device.yaml
+
+properties:
+  label:
+    required: true
+

samples/net/cloud/tagoio_http_post/README.rst

@@ -89,6 +89,10 @@ Modem support or you can add a shield.  Currently, the overlay was created to
 allow modems with PPP support.  This was tested using ``SIMcom SIM808 EVB``.
 Additionally you need fill ``CONFIG_MODEM_GSM_UART_NAME`` with the UART label
 ``CONFIG_MODEM_GSM_APN`` with the correspondent Access Point Name (APN) at
+Additionally you need to add a modem subnode under the UART in the dts, see
+:zephyr_file:`samples/net/gsm_modem/boards/frdm_uart2_dts.overlay`
+and fill ``CONFIG_MODEM_GSM_APN`` with the correspondent Access Point Name
+(APN) at
 :zephyr_file:`samples/net/cloud/tagoio_http_post/overlay-modem.conf` file.
 
 .. zephyr-app-commands::

samples/net/cloud/tagoio_http_post/overlay-modem.conf

@@ -7,7 +7,6 @@ CONFIG_MODEM_SHELL=y
 CONFIG_MODEM_CMD_HANDLER_MAX_PARAM_COUNT=20
 CONFIG_MODEM_GSM_PPP=y
 CONFIG_MODEM_GSM_RX_STACK_SIZE=1024
-CONFIG_MODEM_GSM_UART_NAME="<your board UART port label>"
 CONFIG_MODEM_GSM_APN="<your Access Point Name (APN)>"
 
 # Network management events

samples/net/gsm_modem/boards/frdm_uart2_dts.overlay

@@ -6,4 +6,8 @@
 &uart2 {
 	status = "okay";
 	current-speed = <115200>;
+	gsm: gsm_modem {
+		compatible = "gsm,ppp";
+		label = "gsm modem";
+	};
 };

samples/net/gsm_modem/prj.conf

@@ -4,7 +4,6 @@ CONFIG_SERIAL=y
 # GSM modem support
 CONFIG_MODEM=y
 CONFIG_MODEM_GSM_PPP=y
-CONFIG_MODEM_GSM_UART_NAME="UART_1"
 
 # PPP networking support
 CONFIG_NET_PPP=y

samples/net/gsm_modem/src/main.c

@@ -93,13 +93,13 @@ static void event_handler(struct net_mgmt_event_callback *cb,
 int main(void)
 {
 	const struct device *uart_dev =
-				device_get_binding(CONFIG_MODEM_GSM_UART_NAME);
+				DEVICE_DT_GET(DT_BUS(DT_INST(0, gsm_ppp)));
 
 	gsm_dev = device_get_binding(GSM_MODEM_DEVICE_NAME);
 
 	LOG_INF("Board '%s' APN '%s' UART '%s' device %p (%s)",
 		CONFIG_BOARD, CONFIG_MODEM_GSM_APN,
-		CONFIG_MODEM_GSM_UART_NAME, uart_dev, GSM_MODEM_DEVICE_NAME);
+		DT_BUS_LABEL(DT_INST(0, gsm_ppp)), uart_dev, GSM_MODEM_DEVICE_NAME);
 
 	net_mgmt_init_event_callback(&mgmt_cb, event_handler,
 				     NET_EVENT_L4_CONNECTED |

samples/subsys/mgmt/updatehub/arduino.overlay

@@ -6,7 +6,9 @@
 
 &arduino_serial {
 	status = "okay";
-	label = "arduino_serial";
+	gsm: gsm_modem {
+		compatible = "gsm,ppp";
+	};
 
 	current-speed = <115200>;
 };