OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/drivers/modem/modem_socket.h

87 lines
2.2 KiB
C
Raw Normal View History

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 23:04:00 +08:00
/** @file
* @brief Modem socket header file.
*
* Generic modem socket and packet size implementation for modem context
*/
/*
drivers: modem: socket: introduce locking Add lock behavior for functions in modem_socket, to prevent race conditions when performing socket data maintenance. Signed-off-by: Michael Scott <mike@foundries.io>
2020-01-28 04:59:33 +08:00
* Copyright (c) 2019-2020 Foundries.io
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 23:04:00 +08:00
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_MODEM_MODEM_SOCKET_H_
#define ZEPHYR_INCLUDE_DRIVERS_MODEM_MODEM_SOCKET_H_
#include <kernel.h>
#include <net/net_ip.h>
drivers: modem: ublox-sara-r4: Rework offloading mechanism Switch to `NET_SOCKET_REGISTER` mechanism over the offloaded API registration. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-12-04 17:04:07 +08:00
#include <net/socket.h>
#include "sockets_internal.h"
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 23:04:00 +08:00
#ifdef __cplusplus
extern "C" {
#endif
struct modem_socket {
sa_family_t family;
enum net_sock_type type;
enum net_ip_protocol ip_proto;
struct sockaddr src;
struct sockaddr dst;
int id;
int sock_fd;
/** packet data */
u16_t packet_sizes[CONFIG_MODEM_SOCKET_PACKET_COUNT];
u16_t packet_count;
/** data ready semaphore */
struct k_sem sem_data_ready;
/** socket state */
drivers: modem: socket: add wait_data and data_ready functions Let's hide the internals of the modem_socket's sem_data_ready and poll handling with 2 new functions: - modem_socket_wait_data: take a semaphore and wait for data - modem_socket_data_ready: give back the data ready semaphore and unblock poll() users Signed-off-by: Michael Scott <mike@foundries.io>
2020-01-28 04:52:56 +08:00
bool is_waiting;
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 23:04:00 +08:00
bool is_polled;
/** temporary socket data */
void *data;
};
struct modem_socket_config {
struct modem_socket *sockets;
size_t sockets_len;
/* beginning socket id (modems can set this to 0 or 1 as needed) */
int base_socket_num;
struct k_sem sem_poll;
drivers: modem: socket: introduce locking Add lock behavior for functions in modem_socket, to prevent race conditions when performing socket data maintenance. Signed-off-by: Michael Scott <mike@foundries.io>
2020-01-28 04:59:33 +08:00
struct k_sem sem_lock;
drivers: modem: ublox-sara-r4: Rework offloading mechanism Switch to `NET_SOCKET_REGISTER` mechanism over the offloaded API registration. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-12-04 17:04:07 +08:00
const struct socket_op_vtable *vtable;
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 23:04:00 +08:00
};
/* return total size of remaining packets */
int modem_socket_packet_size_update(struct modem_socket_config *cfg,
struct modem_socket *sock, int new_total);
int modem_socket_get(struct modem_socket_config *cfg, int family, int type,
int proto);
struct modem_socket *modem_socket_from_fd(struct modem_socket_config *cfg,
int sock_fd);
struct modem_socket *modem_socket_from_id(struct modem_socket_config *cfg,
int id);
struct modem_socket *modem_socket_from_newid(struct modem_socket_config *cfg);
void modem_socket_put(struct modem_socket_config *cfg, int sock_fd);
int modem_socket_poll(struct modem_socket_config *cfg,
struct pollfd *fds, int nfds, int msecs);
drivers: modem: socket: add wait_data and data_ready functions Let's hide the internals of the modem_socket's sem_data_ready and poll handling with 2 new functions: - modem_socket_wait_data: take a semaphore and wait for data - modem_socket_data_ready: give back the data ready semaphore and unblock poll() users Signed-off-by: Michael Scott <mike@foundries.io>
2020-01-28 04:52:56 +08:00
void modem_socket_wait_data(struct modem_socket_config *cfg,
struct modem_socket *sock);
void modem_socket_data_ready(struct modem_socket_config *cfg,
struct modem_socket *sock);
drivers: modem: ublox-sara-r4: Rework offloading mechanism Switch to `NET_SOCKET_REGISTER` mechanism over the offloaded API registration. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-12-04 17:04:07 +08:00
int modem_socket_init(struct modem_socket_config *cfg,
const struct socket_op_vtable *vtable);
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 23:04:00 +08:00
#ifdef __cplusplus
}
#endif
#endif /* ZEPHYR_INCLUDE_DRIVERS_MODEM_MODEM_SOCKET_H_ */