Phonet: fix flawed "SYN/ACK" logic
[linux-3.10.git] / include / net / phonet / pep.h
1 /*
2  * File: pep.h
3  *
4  * Phonet Pipe End Point sockets definitions
5  *
6  * Copyright (C) 2008 Nokia Corporation.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  */
22
23 #ifndef NET_PHONET_PEP_H
24 #define NET_PHONET_PEP_H
25
26 struct pep_sock {
27         struct pn_sock          pn_sk;
28
29         /* XXX: union-ify listening vs connected stuff ? */
30         /* Listening socket stuff: */
31         struct hlist_head       ackq;
32         struct hlist_head       hlist;
33
34         /* Connected socket stuff: */
35         struct sock             *listener;
36         struct sk_buff_head     ctrlreq_queue;
37 #define PNPIPE_CTRLREQ_MAX      10
38         atomic_t                tx_credits;
39         int                     ifindex;
40         u16                     peer_type;      /* peer type/subtype */
41         u8                      pipe_handle;
42
43         u8                      rx_credits;
44         u8                      rx_fc;  /* RX flow control */
45         u8                      tx_fc;  /* TX flow control */
46         u8                      init_enable;    /* auto-enable at creation */
47         u8                      aligned;
48 };
49
50 static inline struct pep_sock *pep_sk(struct sock *sk)
51 {
52         return (struct pep_sock *)sk;
53 }
54
55 extern const struct proto_ops phonet_stream_ops;
56
57 /* Pipe protocol definitions */
58 struct pnpipehdr {
59         u8                      utid; /* transaction ID */
60         u8                      message_id;
61         u8                      pipe_handle;
62         union {
63                 u8              state_after_connect;    /* connect request */
64                 u8              state_after_reset;      /* reset request */
65                 u8              error_code;             /* any response */
66                 u8              pep_type;               /* status indication */
67                 u8              data[1];
68         };
69 };
70 #define other_pep_type          data[1]
71
72 static inline struct pnpipehdr *pnp_hdr(struct sk_buff *skb)
73 {
74         return (struct pnpipehdr *)skb_transport_header(skb);
75 }
76
77 #define MAX_PNPIPE_HEADER (MAX_PHONET_HEADER + 4)
78
79 enum {
80         PNS_PIPE_CREATE_REQ = 0x00,
81         PNS_PIPE_CREATE_RESP,
82         PNS_PIPE_REMOVE_REQ,
83         PNS_PIPE_REMOVE_RESP,
84
85         PNS_PIPE_DATA = 0x20,
86         PNS_PIPE_ALIGNED_DATA,
87
88         PNS_PEP_CONNECT_REQ = 0x40,
89         PNS_PEP_CONNECT_RESP,
90         PNS_PEP_DISCONNECT_REQ,
91         PNS_PEP_DISCONNECT_RESP,
92         PNS_PEP_RESET_REQ,
93         PNS_PEP_RESET_RESP,
94         PNS_PEP_ENABLE_REQ,
95         PNS_PEP_ENABLE_RESP,
96         PNS_PEP_CTRL_REQ,
97         PNS_PEP_CTRL_RESP,
98         PNS_PEP_DISABLE_REQ = 0x4C,
99         PNS_PEP_DISABLE_RESP,
100
101         PNS_PEP_STATUS_IND = 0x60,
102         PNS_PIPE_CREATED_IND,
103         PNS_PIPE_RESET_IND = 0x63,
104         PNS_PIPE_ENABLED_IND,
105         PNS_PIPE_REDIRECTED_IND,
106         PNS_PIPE_DISABLED_IND = 0x66,
107 };
108
109 #define PN_PIPE_INVALID_HANDLE  0xff
110 #define PN_PEP_TYPE_COMMON      0x00
111
112 /* Phonet pipe status indication */
113 enum {
114         PN_PEP_IND_FLOW_CONTROL,
115         PN_PEP_IND_ID_MCFC_GRANT_CREDITS,
116 };
117
118 /* Phonet pipe error codes */
119 enum {
120         PN_PIPE_NO_ERROR,
121         PN_PIPE_ERR_INVALID_PARAM,
122         PN_PIPE_ERR_INVALID_HANDLE,
123         PN_PIPE_ERR_INVALID_CTRL_ID,
124         PN_PIPE_ERR_NOT_ALLOWED,
125         PN_PIPE_ERR_PEP_IN_USE,
126         PN_PIPE_ERR_OVERLOAD,
127         PN_PIPE_ERR_DEV_DISCONNECTED,
128         PN_PIPE_ERR_TIMEOUT,
129         PN_PIPE_ERR_ALL_PIPES_IN_USE,
130         PN_PIPE_ERR_GENERAL,
131         PN_PIPE_ERR_NOT_SUPPORTED,
132 };
133
134 /* Phonet pipe states */
135 enum {
136         PN_PIPE_DISABLE,
137         PN_PIPE_ENABLE,
138 };
139
140 /* Phonet pipe sub-block types */
141 enum {
142         PN_PIPE_SB_CREATE_REQ_PEP_SUB_TYPE,
143         PN_PIPE_SB_CONNECT_REQ_PEP_SUB_TYPE,
144         PN_PIPE_SB_REDIRECT_REQ_PEP_SUB_TYPE,
145         PN_PIPE_SB_NEGOTIATED_FC,
146         PN_PIPE_SB_REQUIRED_FC_TX,
147         PN_PIPE_SB_PREFERRED_FC_RX,
148         PN_PIPE_SB_ALIGNED_DATA,
149 };
150
151 /* Phonet pipe flow control models */
152 enum {
153         PN_NO_FLOW_CONTROL,
154         PN_LEGACY_FLOW_CONTROL,
155         PN_ONE_CREDIT_FLOW_CONTROL,
156         PN_MULTI_CREDIT_FLOW_CONTROL,
157         PN_MAX_FLOW_CONTROL,
158 };
159
160 #define pn_flow_safe(fc) ((fc) >> 1)
161
162 /* Phonet pipe flow control states */
163 enum {
164         PEP_IND_EMPTY,
165         PEP_IND_BUSY,
166         PEP_IND_READY,
167 };
168
169 #endif