Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
ppp.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_NET_PPP_H_
13#define ZEPHYR_INCLUDE_NET_PPP_H_
14
15#include <zephyr/net/net_if.h>
16#include <zephyr/net/net_pkt.h>
18#include <zephyr/net/net_mgmt.h>
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
34#define PPP_MRU CONFIG_NET_PPP_MTU_MRU
35
37#define PPP_MTU PPP_MRU
38
40#define PPP_MAX_TERMINATE_REASON_LEN 32
41
43#define PPP_INTERFACE_IDENTIFIER_LEN 8
44
46struct ppp_api {
51 struct net_if_api iface_api;
52
54 int (*start)(const struct device *dev);
55
57 int (*stop)(const struct device *dev);
58
60 int (*send)(const struct device *dev, struct net_pkt *pkt);
61
62#if defined(CONFIG_NET_STATISTICS_PPP)
67 struct net_stats_ppp *(*get_stats)(const struct device *dev);
68#endif
69};
70
71/* Make sure that the network interface API is properly setup inside
72 * PPP API struct (it is the first one).
73 */
74BUILD_ASSERT(offsetof(struct ppp_api, iface_api) == 0);
75
82 PPP_IP = 0x0021,
83 PPP_IPV6 = 0x0057,
84 PPP_IPCP = 0x8021,
85 PPP_ECP = 0x8053,
86 PPP_IPV6CP = 0x8057,
87 PPP_CCP = 0x80FD,
88 PPP_LCP = 0xc021,
89 PPP_PAP = 0xc023,
90 PPP_CHAP = 0xc223,
91 PPP_EAP = 0xc227,
92};
93
111
117enum ppp_state {
118 PPP_INITIAL,
119 PPP_STARTING,
120 PPP_CLOSED,
121 PPP_STOPPED,
122 PPP_CLOSING,
123 PPP_STOPPING,
124 PPP_REQUEST_SENT,
125 PPP_ACK_RECEIVED,
126 PPP_ACK_SENT,
127 PPP_OPENED
128};
129
133enum ppp_packet_type {
134 PPP_CONFIGURE_REQ = 1,
135 PPP_CONFIGURE_ACK = 2,
136 PPP_CONFIGURE_NACK = 3,
137 PPP_CONFIGURE_REJ = 4,
138 PPP_TERMINATE_REQ = 5,
139 PPP_TERMINATE_ACK = 6,
140 PPP_CODE_REJ = 7,
141 PPP_PROTOCOL_REJ = 8,
142 PPP_ECHO_REQ = 9,
143 PPP_ECHO_REPLY = 10,
144 PPP_DISCARD_REQ = 11
145};
146
177
208
219
228typedef void (*net_ppp_lcp_echo_reply_cb_t)(void *user_data,
229 size_t user_data_len);
230
231struct ppp_my_option_data;
232struct ppp_my_option_info;
233
237struct ppp_fsm {
240
242 struct {
244 int (*config_info_ack)(struct ppp_fsm *fsm,
245 struct net_pkt *pkt,
246 uint16_t length);
247
249 struct net_pkt *(*config_info_add)(struct ppp_fsm *fsm);
250
252 int (*config_info_len)(struct ppp_fsm *fsm);
253
255 int (*config_info_nack)(struct ppp_fsm *fsm,
256 struct net_pkt *pkt,
257 uint16_t length,
258 bool rejected);
259
261 int (*config_info_req)(struct ppp_fsm *fsm,
262 struct net_pkt *pkt,
263 uint16_t length,
264 struct net_pkt *ret_pkt);
265
267 int (*config_info_rej)(struct ppp_fsm *fsm,
268 struct net_pkt *pkt,
269 uint16_t length);
270
272 void (*config_info_reset)(struct ppp_fsm *fsm);
273
275 void (*up)(struct ppp_fsm *fsm);
276
278 void (*down)(struct ppp_fsm *fsm);
279
281 void (*starting)(struct ppp_fsm *fsm);
282
284 void (*finished)(struct ppp_fsm *fsm);
285
287 void (*proto_reject)(struct ppp_fsm *fsm);
288
290 void (*retransmit)(struct ppp_fsm *fsm);
291
295 enum net_verdict (*proto_extension)(struct ppp_fsm *fsm,
296 enum ppp_packet_type code,
297 uint8_t id,
298 struct net_pkt *pkt);
299 } cb;
300
302 struct {
304 const struct ppp_my_option_info *info;
305
307 struct ppp_my_option_data *data;
308
310 size_t count;
312
315
316;
318
321
324
327
330
332 enum ppp_state state;
333
335 const char *name;
336
339
342
345};
346
349#define PPP_MY_OPTION_ACKED BIT(0)
350#define PPP_MY_OPTION_REJECTED BIT(1)
351
352struct ppp_my_option_data {
354};
355
356#define IPCP_NUM_MY_OPTIONS 3
357#define IPV6CP_NUM_MY_OPTIONS 1
358
359enum ppp_flags {
360 PPP_CARRIER_UP,
361};
362
379
380#if defined(CONFIG_NET_L2_PPP_OPTION_MRU)
381#define LCP_NUM_MY_OPTIONS 1
382#endif
383
388
391
394};
395
401
408
411
413 struct {
415 struct ppp_fsm fsm;
416
418 struct lcp_options my_options;
419
421 struct lcp_options peer_options;
422
425#if defined(CONFIG_NET_L2_PPP_OPTION_MRU)
426 struct ppp_my_option_data my_options_data[LCP_NUM_MY_OPTIONS];
427#endif
429
430#if defined(CONFIG_NET_IPV4)
432 struct {
434 struct ppp_fsm fsm;
435
437 struct ipcp_options my_options;
438
440 struct ipcp_options peer_options;
441
443 struct ppp_my_option_data my_options_data[IPCP_NUM_MY_OPTIONS];
444 } ipcp;
445#endif
446
447#if defined(CONFIG_NET_IPV6)
449 struct {
451 struct ppp_fsm fsm;
452
454 struct ipv6cp_options my_options;
455
457 struct ipv6cp_options peer_options;
458
460 struct ppp_my_option_data my_options_data[IPV6CP_NUM_MY_OPTIONS];
461 } ipv6cp;
462#endif
463
464#if defined(CONFIG_NET_L2_PPP_PAP)
466 struct {
468 struct ppp_fsm fsm;
469 } pap;
470#endif
471
472#if defined(CONFIG_NET_SHELL)
474 struct {
476 struct {
480
482 void *user_data;
483
485 size_t user_data_len;
486 } echo_reply;
487
489 struct k_sem wait_echo_reply;
490
492 uint32_t echo_req_data;
493
495 uint32_t echo_reply_data;
496 } shell;
497#endif
498
500 struct net_if *iface;
501
504
507
510
512 struct k_sem wait_ppp_link_down;
513
516
519
522
525
528
531
534
537
540
543
546
549};
550
556void net_ppp_init(struct net_if *iface);
557
558/* Management API for PPP */
559
562#define PPP_L2_CTX_TYPE struct ppp_context
563
564#define _NET_PPP_LAYER NET_MGMT_LAYER_L2
565#define _NET_PPP_CODE 0x209
566#define _NET_PPP_BASE (NET_MGMT_IFACE_BIT | \
567 NET_MGMT_LAYER(_NET_PPP_LAYER) | \
568 NET_MGMT_LAYER_CODE(_NET_PPP_CODE))
569#define _NET_PPP_EVENT (_NET_PPP_BASE | NET_MGMT_EVENT_BIT)
570
571enum net_event_ppp_cmd {
572 NET_EVENT_PPP_CMD_CARRIER_ON = 1,
573 NET_EVENT_PPP_CMD_CARRIER_OFF,
574 NET_EVENT_PPP_CMD_PHASE_RUNNING,
575 NET_EVENT_PPP_CMD_PHASE_DEAD,
576};
577
578struct net_if;
579
583#define NET_EVENT_PPP_CARRIER_ON \
584 (_NET_PPP_EVENT | NET_EVENT_PPP_CMD_CARRIER_ON)
585
587#define NET_EVENT_PPP_CARRIER_OFF \
588 (_NET_PPP_EVENT | NET_EVENT_PPP_CMD_CARRIER_OFF)
589
591#define NET_EVENT_PPP_PHASE_RUNNING \
592 (_NET_PPP_EVENT | NET_EVENT_PPP_CMD_PHASE_RUNNING)
593
595#define NET_EVENT_PPP_PHASE_DEAD \
596 (_NET_PPP_EVENT | NET_EVENT_PPP_CMD_PHASE_DEAD)
597
603#if defined(CONFIG_NET_L2_PPP_MGMT)
604void ppp_mgmt_raise_carrier_on_event(struct net_if *iface);
605#else
606static inline void ppp_mgmt_raise_carrier_on_event(struct net_if *iface)
607{
608 ARG_UNUSED(iface);
609}
610#endif
611
617#if defined(CONFIG_NET_L2_PPP_MGMT)
618void ppp_mgmt_raise_carrier_off_event(struct net_if *iface);
619#else
620static inline void ppp_mgmt_raise_carrier_off_event(struct net_if *iface)
621{
622 ARG_UNUSED(iface);
623}
624#endif
625
631#if defined(CONFIG_NET_L2_PPP_MGMT)
633#else
634static inline void ppp_mgmt_raise_phase_running_event(struct net_if *iface)
635{
636 ARG_UNUSED(iface);
637}
638#endif
639
645#if defined(CONFIG_NET_L2_PPP_MGMT)
646void ppp_mgmt_raise_phase_dead_event(struct net_if *iface);
647#else
648static inline void ppp_mgmt_raise_phase_dead_event(struct net_if *iface)
649{
650 ARG_UNUSED(iface);
651}
652#endif
653
664#if defined(CONFIG_NET_L2_PPP)
665int net_ppp_ping(int idx, int32_t timeout);
666#else
667static inline int net_ppp_ping(int idx, int32_t timeout)
668{
669 ARG_UNUSED(idx);
670 ARG_UNUSED(timeout);
671
672 return -ENOTSUP;
673}
674#endif
675
684#if defined(CONFIG_NET_L2_PPP) && defined(CONFIG_NET_SHELL)
685struct ppp_context *net_ppp_context_get(int idx);
686#else
687static inline struct ppp_context *net_ppp_context_get(int idx)
688{
689 ARG_UNUSED(idx);
690
691 return NULL;
692}
693#endif
694
695#ifdef __cplusplus
696}
697#endif
698
703#endif /* ZEPHYR_INCLUDE_NET_PPP_H_ */
long atomic_t
Definition atomic_types.h:15
net_verdict
Net Verdict.
Definition net_core.h:102
net_l2_flags
L2 flags.
Definition net_l2.h:36
ipcp_option_type
IPCP option types from RFC 1332.
Definition ppp.h:181
static void ppp_mgmt_raise_carrier_on_event(struct net_if *iface)
Raise CARRIER_ON event when PPP is connected.
Definition ppp.h:606
void(* net_ppp_lcp_echo_reply_cb_t)(void *user_data, size_t user_data_len)
A callback function that can be called if a Echo-Reply needs to be received.
Definition ppp.h:228
ppp_phase
PPP phases.
Definition ppp.h:97
#define PPP_MAX_TERMINATE_REASON_LEN
Max length of terminate description string.
Definition ppp.h:40
static struct ppp_context * net_ppp_context_get(int idx)
Get PPP context information.
Definition ppp.h:687
static void ppp_mgmt_raise_phase_running_event(struct net_if *iface)
Raise PHASE_RUNNING event when PPP reaching RUNNING phase.
Definition ppp.h:634
ppp_protocol_type
PPP protocol types.
Definition ppp.h:81
static int net_ppp_ping(int idx, int32_t timeout)
Send PPP Echo-Request to peer.
Definition ppp.h:667
void net_ppp_init(struct net_if *iface)
Initialize PPP L2 stack for a given interface.
#define PPP_INTERFACE_IDENTIFIER_LEN
Length of network interface identifier.
Definition ppp.h:43
lcp_option_type
LCP option types from RFC 1661 ch.
Definition ppp.h:152
static void ppp_mgmt_raise_phase_dead_event(struct net_if *iface)
Raise PHASE_DEAD event when PPP reaching DEAD phase.
Definition ppp.h:648
static void ppp_mgmt_raise_carrier_off_event(struct net_if *iface)
Raise CARRIER_OFF event when PPP is disconnected.
Definition ppp.h:620
ipv6cp_option_type
IPV6CP option types from RFC 5072.
Definition ppp.h:212
@ IPCP_OPTION_IP_ADDRESS
IP Address.
Definition ppp.h:192
@ IPCP_OPTION_DNS2
Secondary DNS Server Address.
Definition ppp.h:203
@ IPCP_OPTION_IP_COMP_PROTO
IP Compression Protocol.
Definition ppp.h:189
@ IPCP_OPTION_NBNS2
Secondary NBNS Server Address.
Definition ppp.h:206
@ IPCP_OPTION_RESERVED
Reserved IPCP option value (do not use)
Definition ppp.h:183
@ IPCP_OPTION_NBNS1
Primary NBNS Server Address.
Definition ppp.h:200
@ IPCP_OPTION_IP_ADDRESSES
IP Addresses.
Definition ppp.h:186
@ IPCP_OPTION_DNS1
Primary DNS Server Address.
Definition ppp.h:197
@ PPP_AUTH
Link authentication with peer.
Definition ppp.h:103
@ PPP_RUNNING
Network running.
Definition ppp.h:107
@ PPP_NETWORK
Network connection establishment.
Definition ppp.h:105
@ PPP_ESTABLISH
Link is being established.
Definition ppp.h:101
@ PPP_DEAD
Physical-layer not ready.
Definition ppp.h:99
@ PPP_TERMINATE
Link termination.
Definition ppp.h:109
@ PPP_IPV6
RFC 5072.
Definition ppp.h:83
@ PPP_IP
RFC 1332.
Definition ppp.h:82
@ PPP_CHAP
RFC 1334.
Definition ppp.h:90
@ PPP_LCP
RFC 1661.
Definition ppp.h:88
@ PPP_IPCP
RFC 1332.
Definition ppp.h:84
@ PPP_ECP
RFC 1968.
Definition ppp.h:85
@ PPP_CCP
RFC 1962.
Definition ppp.h:87
@ PPP_EAP
RFC 2284.
Definition ppp.h:91
@ PPP_IPV6CP
RFC 5072.
Definition ppp.h:86
@ PPP_PAP
RFC 1334.
Definition ppp.h:89
@ LCP_OPTION_ASYNC_CTRL_CHAR_MAP
Async-Control-Character-Map.
Definition ppp.h:160
@ LCP_OPTION_ADDR_CTRL_COMPRESS
Address-and-Control-Field-Compression.
Definition ppp.h:175
@ LCP_OPTION_QUALITY_PROTO
Quality-Protocol.
Definition ppp.h:166
@ LCP_OPTION_MAGIC_NUMBER
Magic-Number.
Definition ppp.h:169
@ LCP_OPTION_RESERVED
Reserved option value (do not use)
Definition ppp.h:154
@ LCP_OPTION_PROTO_COMPRESS
Protocol-Field-Compression.
Definition ppp.h:172
@ LCP_OPTION_MRU
Maximum-Receive-Unit.
Definition ppp.h:157
@ LCP_OPTION_AUTH_PROTO
Authentication-Protocol.
Definition ppp.h:163
@ IPV6CP_OPTION_INTERFACE_IDENTIFIER
Interface identifier.
Definition ppp.h:217
@ IPV6CP_OPTION_RESERVED
Reserved IPV6CP option value (do not use)
Definition ppp.h:214
#define ENOTSUP
Unsupported value.
Definition errno.h:114
Public API for network interface.
Network Management API public header.
Network packet buffer descriptor API.
Network statistics.
flags
Definition parser.h:96
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__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:412
IPv4 address struct.
Definition net_ip.h:154
IPv4 control protocol options.
Definition ppp.h:385
struct in_addr address
IPv4 address.
Definition ppp.h:387
struct in_addr dns2_address
Secondary DNS server address.
Definition ppp.h:393
struct in_addr dns1_address
Primary DNS server address.
Definition ppp.h:390
IPv6 control protocol options.
Definition ppp.h:397
uint8_t iid[8]
Interface identifier.
Definition ppp.h:399
A structure used to submit work after a delay.
Definition kernel.h:3985
Link control protocol options.
Definition ppp.h:366
uint16_t mru
Maximum Receive Unit value.
Definition ppp.h:374
uint32_t async_map
Async char map.
Definition ppp.h:371
uint16_t auth_proto
Which authentication protocol was negotiated (0 means none)
Definition ppp.h:377
uint32_t magic
Magic number.
Definition ppp.h:368
Network Interface structure.
Definition net_if.h:680
Network Management event callback structure Used to register a callback into the network management e...
Definition net_mgmt.h:145
Network packet.
Definition net_pkt.h:69
All PPP specific statistics.
Definition net_stats.h:596
PPP L2 API.
Definition ppp.h:46
int(* stop)(const struct device *dev)
Stop the device.
Definition ppp.h:57
int(* send)(const struct device *dev, struct net_pkt *pkt)
Send a network packet.
Definition ppp.h:60
int(* start)(const struct device *dev)
Start the device.
Definition ppp.h:54
struct net_if_api iface_api
The net_if_api must be placed in first position in this struct so that we are compatible with network...
Definition ppp.h:51
PPP L2 context specific to certain network interface.
Definition ppp.h:403
struct net_mgmt_event_callback mgmt_evt_cb
Network management callback structure.
Definition ppp.h:503
struct k_sem wait_ppp_link_terminated
Signal when PPP link is terminated.
Definition ppp.h:509
enum net_l2_flags ppp_l2_flags
This tells what features the PPP supports.
Definition ppp.h:515
int network_protos_open
This tells how many network protocols are open.
Definition ppp.h:518
struct net_if * iface
Network interface related to this PPP connection.
Definition ppp.h:500
uint16_t is_ready_to_serve
Is PPP ready to receive packets.
Definition ppp.h:524
uint32_t magic
Magic-Number value.
Definition ppp.h:424
uint16_t is_pap_up
PAP status (up / down)
Definition ppp.h:545
struct k_work_delayable startup
PPP startup worker.
Definition ppp.h:410
enum ppp_phase phase
Current phase of PPP link.
Definition ppp.h:506
atomic_t flags
Flags representing PPP state, which are accessed from multiple threads.
Definition ppp.h:407
uint16_t is_ipv6cp_up
IPV6CP status (up / down)
Definition ppp.h:539
uint16_t is_ipcp_open
IPCP open status (open / closed)
Definition ppp.h:536
uint16_t is_enabled
Is PPP L2 enabled or not.
Definition ppp.h:527
uint16_t is_pap_open
PAP open status (open / closed)
Definition ppp.h:548
uint16_t is_ipcp_up
IPCP status (up / down)
Definition ppp.h:533
int network_protos_up
This tells how many network protocols are up.
Definition ppp.h:521
struct ppp_context::@406 lcp
LCP options.
uint16_t is_ipv6cp_open
IPV6CP open status (open / closed)
Definition ppp.h:542
uint16_t is_enable_done
PPP enable pending.
Definition ppp.h:530
struct k_sem wait_ppp_link_down
Signal when PPP link is down.
Definition ppp.h:512
Generic PPP Finite State Machine.
Definition ppp.h:237
char terminate_reason[32]
Reason for closing protocol.
Definition ppp.h:326
uint32_t nack_loops
Number of NACK loops since last ACK.
Definition ppp.h:320
const struct ppp_my_option_info * info
Options information.
Definition ppp.h:304
uint16_t protocol
PPP protocol number for this FSM.
Definition ppp.h:329
uint32_t retransmits
Number of re-transmissions left.
Definition ppp.h:317
uint8_t ack_received
Have received valid Ack, Nack or Reject to a Request.
Definition ppp.h:344
uint32_t flags
Option bits.
Definition ppp.h:314
uint32_t recv_nack_loops
Number of NACKs received.
Definition ppp.h:323
struct ppp_my_option_data * data
Options negotiation data.
Definition ppp.h:307
struct ppp_fsm::@405 my_options
My options.
size_t count
Number of negotiated options.
Definition ppp.h:310
uint8_t id
Current id.
Definition ppp.h:338
uint8_t req_id
Current request id.
Definition ppp.h:341
const char * name
Protocol/layer name of this FSM (for debugging)
Definition ppp.h:335
struct ppp_fsm::@404 cb
FSM callbacks.
enum ppp_state state
Current state of PPP link.
Definition ppp.h:332
struct k_work_delayable timer
Timeout timer.
Definition ppp.h:239
Shell instance internals.
Definition shell.h:890