1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * File: pep.h
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Phonet Pipe End Point sockets definitions
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Copyright (C) 2008 Nokia Corporation.
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #ifndef NET_PHONET_PEP_H
11*4882a593Smuzhiyun #define NET_PHONET_PEP_H
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun struct pep_sock {
14*4882a593Smuzhiyun struct pn_sock pn_sk;
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun /* XXX: union-ify listening vs connected stuff ? */
17*4882a593Smuzhiyun /* Listening socket stuff: */
18*4882a593Smuzhiyun struct hlist_head hlist;
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun /* Connected socket stuff: */
21*4882a593Smuzhiyun struct sock *listener;
22*4882a593Smuzhiyun struct sk_buff_head ctrlreq_queue;
23*4882a593Smuzhiyun #define PNPIPE_CTRLREQ_MAX 10
24*4882a593Smuzhiyun atomic_t tx_credits;
25*4882a593Smuzhiyun int ifindex;
26*4882a593Smuzhiyun u16 peer_type; /* peer type/subtype */
27*4882a593Smuzhiyun u8 pipe_handle;
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun u8 rx_credits;
30*4882a593Smuzhiyun u8 rx_fc; /* RX flow control */
31*4882a593Smuzhiyun u8 tx_fc; /* TX flow control */
32*4882a593Smuzhiyun u8 init_enable; /* auto-enable at creation */
33*4882a593Smuzhiyun u8 aligned;
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun
pep_sk(struct sock * sk)36*4882a593Smuzhiyun static inline struct pep_sock *pep_sk(struct sock *sk)
37*4882a593Smuzhiyun {
38*4882a593Smuzhiyun return (struct pep_sock *)sk;
39*4882a593Smuzhiyun }
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun extern const struct proto_ops phonet_stream_ops;
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun /* Pipe protocol definitions */
44*4882a593Smuzhiyun struct pnpipehdr {
45*4882a593Smuzhiyun u8 utid; /* transaction ID */
46*4882a593Smuzhiyun u8 message_id;
47*4882a593Smuzhiyun u8 pipe_handle;
48*4882a593Smuzhiyun union {
49*4882a593Smuzhiyun u8 state_after_connect; /* connect request */
50*4882a593Smuzhiyun u8 state_after_reset; /* reset request */
51*4882a593Smuzhiyun u8 error_code; /* any response */
52*4882a593Smuzhiyun u8 pep_type; /* status indication */
53*4882a593Smuzhiyun u8 data0; /* anything else */
54*4882a593Smuzhiyun };
55*4882a593Smuzhiyun u8 data[];
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun #define other_pep_type data[0]
58*4882a593Smuzhiyun
pnp_hdr(struct sk_buff * skb)59*4882a593Smuzhiyun static inline struct pnpipehdr *pnp_hdr(struct sk_buff *skb)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun return (struct pnpipehdr *)skb_transport_header(skb);
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun #define MAX_PNPIPE_HEADER (MAX_PHONET_HEADER + 4)
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun enum {
67*4882a593Smuzhiyun PNS_PIPE_CREATE_REQ = 0x00,
68*4882a593Smuzhiyun PNS_PIPE_CREATE_RESP,
69*4882a593Smuzhiyun PNS_PIPE_REMOVE_REQ,
70*4882a593Smuzhiyun PNS_PIPE_REMOVE_RESP,
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun PNS_PIPE_DATA = 0x20,
73*4882a593Smuzhiyun PNS_PIPE_ALIGNED_DATA,
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun PNS_PEP_CONNECT_REQ = 0x40,
76*4882a593Smuzhiyun PNS_PEP_CONNECT_RESP,
77*4882a593Smuzhiyun PNS_PEP_DISCONNECT_REQ,
78*4882a593Smuzhiyun PNS_PEP_DISCONNECT_RESP,
79*4882a593Smuzhiyun PNS_PEP_RESET_REQ,
80*4882a593Smuzhiyun PNS_PEP_RESET_RESP,
81*4882a593Smuzhiyun PNS_PEP_ENABLE_REQ,
82*4882a593Smuzhiyun PNS_PEP_ENABLE_RESP,
83*4882a593Smuzhiyun PNS_PEP_CTRL_REQ,
84*4882a593Smuzhiyun PNS_PEP_CTRL_RESP,
85*4882a593Smuzhiyun PNS_PEP_DISABLE_REQ = 0x4C,
86*4882a593Smuzhiyun PNS_PEP_DISABLE_RESP,
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun PNS_PEP_STATUS_IND = 0x60,
89*4882a593Smuzhiyun PNS_PIPE_CREATED_IND,
90*4882a593Smuzhiyun PNS_PIPE_RESET_IND = 0x63,
91*4882a593Smuzhiyun PNS_PIPE_ENABLED_IND,
92*4882a593Smuzhiyun PNS_PIPE_REDIRECTED_IND,
93*4882a593Smuzhiyun PNS_PIPE_DISABLED_IND = 0x66,
94*4882a593Smuzhiyun };
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun #define PN_PIPE_INVALID_HANDLE 0xff
97*4882a593Smuzhiyun #define PN_PEP_TYPE_COMMON 0x00
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun /* Phonet pipe status indication */
100*4882a593Smuzhiyun enum {
101*4882a593Smuzhiyun PN_PEP_IND_FLOW_CONTROL,
102*4882a593Smuzhiyun PN_PEP_IND_ID_MCFC_GRANT_CREDITS,
103*4882a593Smuzhiyun };
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun /* Phonet pipe error codes */
106*4882a593Smuzhiyun enum {
107*4882a593Smuzhiyun PN_PIPE_NO_ERROR,
108*4882a593Smuzhiyun PN_PIPE_ERR_INVALID_PARAM,
109*4882a593Smuzhiyun PN_PIPE_ERR_INVALID_HANDLE,
110*4882a593Smuzhiyun PN_PIPE_ERR_INVALID_CTRL_ID,
111*4882a593Smuzhiyun PN_PIPE_ERR_NOT_ALLOWED,
112*4882a593Smuzhiyun PN_PIPE_ERR_PEP_IN_USE,
113*4882a593Smuzhiyun PN_PIPE_ERR_OVERLOAD,
114*4882a593Smuzhiyun PN_PIPE_ERR_DEV_DISCONNECTED,
115*4882a593Smuzhiyun PN_PIPE_ERR_TIMEOUT,
116*4882a593Smuzhiyun PN_PIPE_ERR_ALL_PIPES_IN_USE,
117*4882a593Smuzhiyun PN_PIPE_ERR_GENERAL,
118*4882a593Smuzhiyun PN_PIPE_ERR_NOT_SUPPORTED,
119*4882a593Smuzhiyun };
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun /* Phonet pipe states */
122*4882a593Smuzhiyun enum {
123*4882a593Smuzhiyun PN_PIPE_DISABLE,
124*4882a593Smuzhiyun PN_PIPE_ENABLE,
125*4882a593Smuzhiyun };
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun /* Phonet pipe sub-block types */
128*4882a593Smuzhiyun enum {
129*4882a593Smuzhiyun PN_PIPE_SB_CREATE_REQ_PEP_SUB_TYPE,
130*4882a593Smuzhiyun PN_PIPE_SB_CONNECT_REQ_PEP_SUB_TYPE,
131*4882a593Smuzhiyun PN_PIPE_SB_REDIRECT_REQ_PEP_SUB_TYPE,
132*4882a593Smuzhiyun PN_PIPE_SB_NEGOTIATED_FC,
133*4882a593Smuzhiyun PN_PIPE_SB_REQUIRED_FC_TX,
134*4882a593Smuzhiyun PN_PIPE_SB_PREFERRED_FC_RX,
135*4882a593Smuzhiyun PN_PIPE_SB_ALIGNED_DATA,
136*4882a593Smuzhiyun };
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun /* Phonet pipe flow control models */
139*4882a593Smuzhiyun enum {
140*4882a593Smuzhiyun PN_NO_FLOW_CONTROL,
141*4882a593Smuzhiyun PN_LEGACY_FLOW_CONTROL,
142*4882a593Smuzhiyun PN_ONE_CREDIT_FLOW_CONTROL,
143*4882a593Smuzhiyun PN_MULTI_CREDIT_FLOW_CONTROL,
144*4882a593Smuzhiyun PN_MAX_FLOW_CONTROL,
145*4882a593Smuzhiyun };
146*4882a593Smuzhiyun
147*4882a593Smuzhiyun #define pn_flow_safe(fc) ((fc) >> 1)
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun /* Phonet pipe flow control states */
150*4882a593Smuzhiyun enum {
151*4882a593Smuzhiyun PEP_IND_EMPTY,
152*4882a593Smuzhiyun PEP_IND_BUSY,
153*4882a593Smuzhiyun PEP_IND_READY,
154*4882a593Smuzhiyun };
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun #endif
157