Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
ppp.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Trackunit Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#include <zephyr/kernel.h>
8#include <zephyr/types.h>
9#include <zephyr/net/net_if.h>
10#include <zephyr/net/net_pkt.h>
12#include <zephyr/sys/atomic.h>
13
14#include <zephyr/modem/pipe.h>
15#include <zephyr/modem/stats.h>
16
17#ifndef ZEPHYR_MODEM_PPP_
18#define ZEPHYR_MODEM_PPP_
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
32
34typedef void (*modem_ppp_init_iface)(struct net_if *iface);
35
39
40enum modem_ppp_receive_state {
41 /* Searching for start of frame and header */
42 MODEM_PPP_RECEIVE_STATE_HDR_SOF = 0,
43 MODEM_PPP_RECEIVE_STATE_HDR_FF,
44 MODEM_PPP_RECEIVE_STATE_HDR_7D,
45 MODEM_PPP_RECEIVE_STATE_HDR_23,
46 /* Writing bytes to network packet */
47 MODEM_PPP_RECEIVE_STATE_WRITING,
48 /* Unescaping next byte before writing to network packet */
49 MODEM_PPP_RECEIVE_STATE_UNESCAPING,
50};
51
52enum modem_ppp_transmit_state {
53 MODEM_PPP_TRANSMIT_STATE_IDLE = 0,
54 MODEM_PPP_TRANSMIT_STATE_SOF,
55 MODEM_PPP_TRANSMIT_STATE_PROTOCOL,
56 MODEM_PPP_TRANSMIT_STATE_DATA,
57 MODEM_PPP_TRANSMIT_STATE_EOF,
58};
59
60struct modem_ppp {
61 /* Network interface instance is bound to */
62 struct net_if *iface;
63
64 /* Hook for PPP L2 network interface initialization */
65 modem_ppp_init_iface init_iface;
66
68
69 /* Buffers used for processing partial frames */
70 uint8_t *receive_buf;
71 uint8_t *transmit_buf;
72 uint16_t buf_size;
73
74 /* Wrapped PPP frames are sent and received through this pipe */
75 struct modem_pipe *pipe;
76
77 /* Receive PPP frame state */
78 enum modem_ppp_receive_state receive_state;
79
80 /* Allocated network packet being created */
81 struct net_pkt *rx_pkt;
82
83 /* Packet being sent */
84 enum modem_ppp_transmit_state transmit_state;
85 struct net_pkt *tx_pkt;
86 uint16_t tx_pkt_fcs;
87
88 /* Ring buffer used for transmitting partial PPP frame */
89 struct ring_buf transmit_rb;
90
91 struct k_fifo tx_pkt_fifo;
92
93 /* Work */
94 struct k_work send_work;
95 struct k_work process_work;
96
97#if defined(CONFIG_NET_STATISTICS_PPP)
98 struct net_stats_ppp stats;
99#endif
100
101#if CONFIG_MODEM_STATS
102 struct modem_stats_buffer receive_buf_stats;
103 struct modem_stats_buffer transmit_buf_stats;
104#endif
105};
106
107struct modem_ppp_config {
108 const struct device *dev;
109};
110
114
121int modem_ppp_attach(struct modem_ppp *ppp, struct modem_pipe *pipe);
122
129struct net_if *modem_ppp_get_iface(struct modem_ppp *ppp);
130
136void modem_ppp_release(struct modem_ppp *ppp);
137
141
147int modem_ppp_init_internal(const struct device *dev);
148
152
170#define MODEM_DEV_PPP_DEFINE(_dev, _name, _init_iface, _prio, _mtu, _buf_size) \
171 extern const struct ppp_api modem_ppp_ppp_api; \
172 \
173 static uint8_t _CONCAT(_name, _receive_buf)[_buf_size]; \
174 static uint8_t _CONCAT(_name, _transmit_buf)[_buf_size]; \
175 \
176 static struct modem_ppp _name = { \
177 .init_iface = _init_iface, \
178 .receive_buf = _CONCAT(_name, _receive_buf), \
179 .transmit_buf = _CONCAT(_name, _transmit_buf), \
180 .buf_size = _buf_size, \
181 }; \
182 static const struct modem_ppp_config _CONCAT(_name, _config) = { \
183 .dev = _dev, \
184 }; \
185 \
186 NET_DEVICE_INIT(_CONCAT(ppp_net_dev_, _name), "modem_ppp_" #_name, \
187 modem_ppp_init_internal, NULL, &_name, &_CONCAT(_name, _config), _prio, \
188 &modem_ppp_ppp_api, PPP_L2, NET_L2_GET_CTX_TYPE(PPP_L2), _mtu)
189
195#define MODEM_DT_INST_PPP_DEFINE(inst, _name, _init_iface, _prio, _mtu, _buf_size) \
196 MODEM_DEV_PPP_DEFINE(DEVICE_DT_INST_GET(inst), _name, _init_iface, _prio, _mtu, _buf_size)
197
203#define MODEM_PPP_DEFINE(_name, _init_iface, _prio, _mtu, _buf_size) \
204 MODEM_DEV_PPP_DEFINE(NULL, _name, _init_iface, _prio, _mtu, _buf_size)
205
209
210#ifdef __cplusplus
211}
212#endif
213
214#endif /* ZEPHYR_MODEM_PPP_ */
long atomic_t
Definition atomic_types.h:15
int modem_ppp_attach(struct modem_ppp *ppp, struct modem_pipe *pipe)
Attach pipe to instance and connect.
struct net_if * modem_ppp_get_iface(struct modem_ppp *ppp)
Get network interface modem PPP instance is bound to.
void modem_ppp_release(struct modem_ppp *ppp)
Release pipe from instance.
void(* modem_ppp_init_iface)(struct net_if *iface)
L2 network interface init callback.
Definition ppp.h:34
Public kernel APIs.
Public API for network interface.
Network packet buffer descriptor API.
state
Definition parser_state.h:29
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
Network Interface structure.
Definition net_if.h:726