Zephyr Project API 3.7.0
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
32typedef void (*modem_ppp_init_iface)(struct net_if *iface);
33
38enum modem_ppp_receive_state {
39 /* Searching for start of frame and header */
40 MODEM_PPP_RECEIVE_STATE_HDR_SOF = 0,
41 MODEM_PPP_RECEIVE_STATE_HDR_FF,
42 MODEM_PPP_RECEIVE_STATE_HDR_7D,
43 MODEM_PPP_RECEIVE_STATE_HDR_23,
44 /* Writing bytes to network packet */
45 MODEM_PPP_RECEIVE_STATE_WRITING,
46 /* Unescaping next byte before writing to network packet */
47 MODEM_PPP_RECEIVE_STATE_UNESCAPING,
48};
49
50enum modem_ppp_transmit_state {
51 /* Idle */
52 MODEM_PPP_TRANSMIT_STATE_IDLE = 0,
53 /* Writing header */
54 MODEM_PPP_TRANSMIT_STATE_SOF,
55 MODEM_PPP_TRANSMIT_STATE_HDR_FF,
56 MODEM_PPP_TRANSMIT_STATE_HDR_7D,
57 MODEM_PPP_TRANSMIT_STATE_HDR_23,
58 /* Writing protocol */
59 MODEM_PPP_TRANSMIT_STATE_PROTOCOL_HIGH,
60 MODEM_PPP_TRANSMIT_STATE_ESCAPING_PROTOCOL_HIGH,
61 MODEM_PPP_TRANSMIT_STATE_PROTOCOL_LOW,
62 MODEM_PPP_TRANSMIT_STATE_ESCAPING_PROTOCOL_LOW,
63 /* Writing data */
64 MODEM_PPP_TRANSMIT_STATE_DATA,
65 MODEM_PPP_TRANSMIT_STATE_ESCAPING_DATA,
66 /* Writing FCS */
67 MODEM_PPP_TRANSMIT_STATE_FCS_LOW,
68 MODEM_PPP_TRANSMIT_STATE_ESCAPING_FCS_LOW,
69 MODEM_PPP_TRANSMIT_STATE_FCS_HIGH,
70 MODEM_PPP_TRANSMIT_STATE_ESCAPING_FCS_HIGH,
71 /* Writing end of frame */
72 MODEM_PPP_TRANSMIT_STATE_EOF,
73};
74
75struct modem_ppp {
76 /* Network interface instance is bound to */
77 struct net_if *iface;
78
79 /* Hook for PPP L2 network interface initialization */
80 modem_ppp_init_iface init_iface;
81
83
84 /* Buffers used for processing partial frames */
85 uint8_t *receive_buf;
86 uint8_t *transmit_buf;
87 uint16_t buf_size;
88
89 /* Wrapped PPP frames are sent and received through this pipe */
90 struct modem_pipe *pipe;
91
92 /* Receive PPP frame state */
93 enum modem_ppp_receive_state receive_state;
94
95 /* Allocated network packet being created */
96 struct net_pkt *rx_pkt;
97
98 /* Packet being sent */
99 enum modem_ppp_transmit_state transmit_state;
100 struct net_pkt *tx_pkt;
101 uint8_t tx_pkt_escaped;
102 uint16_t tx_pkt_protocol;
103 uint16_t tx_pkt_fcs;
104
105 /* Ring buffer used for transmitting partial PPP frame */
106 struct ring_buf transmit_rb;
107
108 struct k_fifo tx_pkt_fifo;
109
110 /* Work */
111 struct k_work send_work;
112 struct k_work process_work;
113
114#if defined(CONFIG_NET_STATISTICS_PPP)
115 struct net_stats_ppp stats;
116#endif
117
118#if CONFIG_MODEM_STATS
119 struct modem_stats_buffer receive_buf_stats;
120 struct modem_stats_buffer transmit_buf_stats;
121#endif
122};
123
134int modem_ppp_attach(struct modem_ppp *ppp, struct modem_pipe *pipe);
135
142struct net_if *modem_ppp_get_iface(struct modem_ppp *ppp);
143
149void modem_ppp_release(struct modem_ppp *ppp);
150
160int modem_ppp_init_internal(const struct device *dev);
161
179#define MODEM_PPP_DEFINE(_name, _init_iface, _prio, _mtu, _buf_size) \
180 extern const struct ppp_api modem_ppp_ppp_api; \
181 \
182 static uint8_t _CONCAT(_name, _receive_buf)[_buf_size]; \
183 static uint8_t _CONCAT(_name, _transmit_buf)[_buf_size]; \
184 \
185 static struct modem_ppp _name = { \
186 .init_iface = _init_iface, \
187 .receive_buf = _CONCAT(_name, _receive_buf), \
188 .transmit_buf = _CONCAT(_name, _transmit_buf), \
189 .buf_size = _buf_size, \
190 }; \
191 \
192 NET_DEVICE_INIT(_CONCAT(ppp_net_dev_, _name), "modem_ppp_" # _name, \
193 modem_ppp_init_internal, NULL, &_name, NULL, _prio, &modem_ppp_ppp_api, \
194 PPP_L2, NET_L2_GET_CTX_TYPE(PPP_L2), _mtu)
195
200#ifdef __cplusplus
201}
202#endif
203
204#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:32
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:403
Definition kernel.h:2391
A structure used to submit work.
Definition kernel.h:3880
Network Interface structure.
Definition net_if.h:678
Network packet.
Definition net_pkt.h:67
All PPP specific statistics.
Definition net_stats.h:575
A structure to represent a ring buffer.
Definition ring_buffer.h:41
static struct k_pipe pipe
Definition test_mutex_error.c:18