michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/drivers/modem/CMakeLists.txt

29 lines
838 B
CMake
Raw Permalink Normal View History

license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 15:08:09 +02:00
# SPDX-License-Identifier: Apache-2.0
drivers: modem: add modem receiver (tty) driver Modem drivers need a fast buffer-based receiver for passing data back and forth from the UART to the driver. This provides an efficient configuarable driver which merely sends and receives but doesn't process the data, that's left up to the modem driver. Signed-off-by: Michael Scott <mike@foundries.io>
2018-08-01 22:01:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_RECEIVER modem_receiver.c)
drivers: modem: add modem shell extension Add a set of modem shell commands to support modem development. Start with: modem list: Lists all registered modems and related information modem send <modem receiver index> <command>: Send command to modem Signed-off-by: Michael Scott <mike@foundries.io>
2018-08-01 22:03:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_SHELL modem_shell.c)
drivers/modem: Switch wncm14a2a driver to new net_pkt API It is a bit awkward that ip/proto headers have to be rebuilt (with fake data in it though). Let's see in future if that's really needed, offload device handles already ip/proto headers by themselves so we should not care. Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2019-02-19 11:17:51 +01:00
drivers: modem: context helper: introduce modem context helper driver Initial support for modems in Zephyr use the following driver model: - Main portions of code live in the modem specific driver. This includes internal socket management, command parsing, etc. - They leverage a UART-based modem receiver helper to gather data. - Interface with Zephyr networking via net_context offload APIs. This implementation was good enough to kick start interest in supporting modem usage in Zephyr, but lacks future scalability: - The net_context offload APIs don't allow for operations such as offloaded DNS, SSL/TLS and other HW specific features. - Since most of the code lives within the modem drivers, it's very hard for the Zephyr community to improve the driver layer over time. Bugs found in 1 driver probably affect others due to copy/paste method of development. - Lack of abstraction for different modem interfaces and command handlers makes it impossible to write a "dummy" layer which could be used for testing. - Lack of centralized processing makes implementing low power modes and other advanced topics more difficult. Introducing the modem context helper driver and sub-layers: - modem context helper acts as an umbrella for several configurable layers and exposes this data to externals such as the modem shell. Included in the helper is GPIO pin config functions which are currently duplicated in most drivers. - modem interface layer: this layer sits on the HW APIs for the peripheral which communicates with the modem. Users of the modem interface can handle data via read/write functions. Individual modem drivers can select from (potentially) several modem interfaces. - modem command parser layer: this layer communicates with the modem interface and processes the data for use by modem drivers. Fixes: https://github.com/zephyrproject-rtos/zephyr/issues/17922 Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:01:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_CONTEXT
modem_context.c
modem_pin.c
)
drivers: modem: interface: introduce UART interface driver layer The UART-based modem interface layer implements the modem context interface for Zephyr's UART APIs. This driver closely resembles the existing modem receiver, but conforming to the modem interface agreements. Example modem driver setup code looks like this: /* create modem context object */ static struct modem_context mctx; /* create uart interface data object and buffers */ static struct modem_iface_uart_data iface_data; static u8_t iface_isr_buf[MDM_RECV_BUF_SIZE]; static u8_t iface_rb_buf[MDM_MAX_DATA_LENGTH]; iface_data.isr_buf = &iface_isr_buf[0]; iface_data.isr_buf_len = sizeof(iface_isr_buf); iface_data.rx_rb_buf = &iface_rb_buf[0]; iface_data.rx_rb_buf_len = sizeof(iface_rb_buf); ret = modem_iface_uart_init(&mctx.iface, &iface_data, UART_DEV_NAME); Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:02:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_IFACE_UART modem_iface_uart.c)
drivers: modem: cmd handler: introduce cmd handler driver layer This is a generic command handler implementation which uses the supplied modem interface to process incoming data and hand it back to the modem driver via callbacks defined for: - modem responses - unsolicited messages - specified handlers for current operation The individual modem drivers define functions as command handlers via the MODEM_CMD_DEFINE() macro. To use these handlers, a modem operation defines a series of modem_cmd structures and passes them to the modem_cmd_send() function. The modem_cmd includes data for: - a matching string for when to execute the handler - # of parameters to parse after the matching string - delimeters for the parameters Example modem driver setup code looks like this: /* create modem context object */ static struct modem_context mctx; /* net_buf receive pool */ NET_BUF_POOL_DEFINE(mdm_recv_pool, MDM_RECV_MAX_BUF, MDM_RECV_BUF_SIZE, 0, NULL); /* modem cmds */ static struct modem_cmd_handler_data cmd_handler_data; static u8_t cmd_read_buf[MDM_RECV_BUF_SIZE]; static u8_t cmd_match_buf[MDM_RECV_BUF_SIZE]; /* modem response handlers */ static struct modem_cmd response_cmds[] = { MODEM_CMD("OK", on_cmd_ok, 0U, ""), MODEM_CMD("ERROR", on_cmd_error, 0U, ""), MODEM_CMD("+CME ERROR: ", on_cmd_exterror, 1U, ""), }; /* unsolicited handlers */ static struct modem_cmd unsol_cmds[] = { MODEM_CMD("+UUSOCL: ", on_cmd_socknotifyclose, 1U, ""), MODEM_CMD("+UUSORD: ", on_cmd_socknotifydata, 2U, ","), MODEM_CMD("+UUSORF: ", on_cmd_socknotifydata, 2U, ","), MODEM_CMD("+CREG: ", on_cmd_socknotifycreg, 1U, ""), }; /* setup cmd handler data */ cmd_handler_data.cmds[CMD_RESP] = response_cmds; cmd_handler_data.cmds_len[CMD_RESP] = ARRAY_SIZE(response_cmds); cmd_handler_data.cmds[CMD_UNSOL] = unsol_cmds; cmd_handler_data.cmds_len[CMD_UNSOL] = ARRAY_SIZE(unsol_cmds); cmd_handler_data.read_buf = &cmd_read_buf[0]; cmd_handler_data.read_buf_len = sizeof(cmd_read_buf); cmd_handler_data.match_buf = &cmd_match_buf[0]; cmd_handler_data.match_buf_len = sizeof(cmd_match_buf); cmd_handler_data.buf_pool = &mdm_recv_pool; cmd_handler_data.alloc_timeout = BUF_ALLOC_TIMEOUT; ret = modem_cmd_handler_init(&mctx.cmd_handler, &cmd_handler_data); Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:03:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_CMD_HANDLER modem_cmd_handler.c)
drivers: modem: introduce socket helper layer Many modems implement socket-based APIs to manage data connections. This layer provides much of the groundwork for keeping track of these "sockets" throughout their lifecycle (from the initial offload API calls through the command handler call back layers): - structure for holding socket data like IP protocol, destination, source and incoming packet sizes - configuration to note modem starting socket id and number of sockets - methods to get/put socket structs from/to the pool - function to update the # and size of packets in the modem receive queue - prebuilt modem_socket_poll() method for socket offload poll() API Example modem driver setup code looks like this: /* socket data */ static struct modem_socket_config socket_config; static struct modem_socket sockets[MDM_MAX_SOCKETS]; static int modem_init(struct device *dev) { ... /* setup socket config */ socket_config.sockets = &sockets[0]; socket_config.sockets_len = ARRAY_SIZE(sockets); socket_config.base_socket_num = 0; ret = modem_socket_init(&socket_config); ... } Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:04:00 +02:00
zephyr_sources_ifdef(CONFIG_MODEM_SOCKET modem_socket.c)
drivers: modem: interface: introduce UART interface driver layer The UART-based modem interface layer implements the modem context interface for Zephyr's UART APIs. This driver closely resembles the existing modem receiver, but conforming to the modem interface agreements. Example modem driver setup code looks like this: /* create modem context object */ static struct modem_context mctx; /* create uart interface data object and buffers */ static struct modem_iface_uart_data iface_data; static u8_t iface_isr_buf[MDM_RECV_BUF_SIZE]; static u8_t iface_rb_buf[MDM_MAX_DATA_LENGTH]; iface_data.isr_buf = &iface_isr_buf[0]; iface_data.isr_buf_len = sizeof(iface_isr_buf); iface_data.rx_rb_buf = &iface_rb_buf[0]; iface_data.rx_rb_buf_len = sizeof(iface_rb_buf); ret = modem_iface_uart_init(&mctx.iface, &iface_data, UART_DEV_NAME); Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:02:00 +02:00
drivers: modem: ublox-sara-r4: Support SARA-U2 modems, sense VINT This adds support for SARA-U2 modems. They have different timings on the PWR_ON pin, don't support AT+CESQ and require a manual GPRS connection setup. The VINT pin is used as a more reliable and faster way to power on the modem. Based on work by Göran Weinholt <goran.weinholt@endian.se> Signed-off-by: Michael Scott <mike@foundries.io>
2019-08-07 17:06:00 +02:00
if(CONFIG_MODEM_UBLOX_SARA)
drivers: modem: introduce u-blox SARA-R4 modem driver The u-blox SARA-R4 modem modules are Ultra-compact LTE Cat M1 / NB1 ready: - Configurable with a single hardware version - Flexible mode selection as LTE Cat M1, LTE Cat NB1, EGPRS - only/preferred - Low power consumption and longer battery life - Extended range in buildings, basements, and with NB1, underground This driver introduces support for basic AT commands to query modem information as well as socket connection for TCP/UDP communication. Signed-off-by: Michael Scott <mike@foundries.io>
2019-05-17 19:14:00 +02:00
zephyr_library_include_directories(${ZEPHYR_BASE}/subsys/net/ip)
zephyr_library_sources(ublox-sara-r4.c)
endif()
drivers/modem: Switch wncm14a2a driver to new net_pkt API It is a bit awkward that ip/proto headers have to be rebuilt (with fake data in it though). Let's see in future if that's really needed, offload device handles already ip/proto headers by themselves so we should not care. Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2019-02-19 11:17:51 +01:00
if(CONFIG_MODEM_WNCM14A2A)
zephyr_library_include_directories(${ZEPHYR_BASE}/subsys/net/ip)
zephyr_library_sources(wncm14a2a.c)
endif()
drivers: modem: Support GSM modems and PPP Create a driver for GSM modems that use a standard AT command set and enable Zephyr's own PPP stack for IP traffic. Signed-off-by: Patrik Flykt <patrik.flykt@intel.com>
2020-01-02 11:41:07 +01:00
if(CONFIG_MODEM_GSM_PPP)
zephyr_library_include_directories(${ZEPHYR_BASE}/subsys/net/ip)
zephyr_library_sources(gsm_ppp.c)
endif()
Copy permalink