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 #ifdef CONFIG_PHONET_PIPECTRLR 49 u8 pipe_state; 50 struct sockaddr_pn remote_pep; 51 #endif 52 }; 53 54 static inline struct pep_sock *pep_sk(struct sock *sk) 55 { 56 return (struct pep_sock *)sk; 57 } 58 59 extern const struct proto_ops phonet_stream_ops; 60 61 /* Pipe protocol definitions */ 62 struct pnpipehdr { 63 u8 utid; /* transaction ID */ 64 u8 message_id; 65 u8 pipe_handle; 66 union { 67 u8 state_after_connect; /* connect request */ 68 u8 state_after_reset; /* reset request */ 69 u8 error_code; /* any response */ 70 u8 pep_type; /* status indication */ 71 u8 data[1]; 72 }; 73 }; 74 #define other_pep_type data[1] 75 76 static inline struct pnpipehdr *pnp_hdr(struct sk_buff *skb) 77 { 78 return (struct pnpipehdr *)skb_transport_header(skb); 79 } 80 81 #define MAX_PNPIPE_HEADER (MAX_PHONET_HEADER + 4) 82 83 enum { 84 PNS_PIPE_CREATE_REQ = 0x00, 85 PNS_PIPE_CREATE_RESP, 86 PNS_PIPE_REMOVE_REQ, 87 PNS_PIPE_REMOVE_RESP, 88 89 PNS_PIPE_DATA = 0x20, 90 PNS_PIPE_ALIGNED_DATA, 91 92 PNS_PEP_CONNECT_REQ = 0x40, 93 PNS_PEP_CONNECT_RESP, 94 PNS_PEP_DISCONNECT_REQ, 95 PNS_PEP_DISCONNECT_RESP, 96 PNS_PEP_RESET_REQ, 97 PNS_PEP_RESET_RESP, 98 PNS_PEP_ENABLE_REQ, 99 PNS_PEP_ENABLE_RESP, 100 PNS_PEP_CTRL_REQ, 101 PNS_PEP_CTRL_RESP, 102 PNS_PEP_DISABLE_REQ = 0x4C, 103 PNS_PEP_DISABLE_RESP, 104 105 PNS_PEP_STATUS_IND = 0x60, 106 PNS_PIPE_CREATED_IND, 107 PNS_PIPE_RESET_IND = 0x63, 108 PNS_PIPE_ENABLED_IND, 109 PNS_PIPE_REDIRECTED_IND, 110 PNS_PIPE_DISABLED_IND = 0x66, 111 }; 112 113 #define PN_PIPE_INVALID_HANDLE 0xff 114 #define PN_PEP_TYPE_COMMON 0x00 115 116 /* Phonet pipe status indication */ 117 enum { 118 PN_PEP_IND_FLOW_CONTROL, 119 PN_PEP_IND_ID_MCFC_GRANT_CREDITS, 120 }; 121 122 /* Phonet pipe error codes */ 123 enum { 124 PN_PIPE_NO_ERROR, 125 PN_PIPE_ERR_INVALID_PARAM, 126 PN_PIPE_ERR_INVALID_HANDLE, 127 PN_PIPE_ERR_INVALID_CTRL_ID, 128 PN_PIPE_ERR_NOT_ALLOWED, 129 PN_PIPE_ERR_PEP_IN_USE, 130 PN_PIPE_ERR_OVERLOAD, 131 PN_PIPE_ERR_DEV_DISCONNECTED, 132 PN_PIPE_ERR_TIMEOUT, 133 PN_PIPE_ERR_ALL_PIPES_IN_USE, 134 PN_PIPE_ERR_GENERAL, 135 PN_PIPE_ERR_NOT_SUPPORTED, 136 }; 137 138 /* Phonet pipe states */ 139 enum { 140 PN_PIPE_DISABLE, 141 PN_PIPE_ENABLE, 142 }; 143 144 /* Phonet pipe sub-block types */ 145 enum { 146 PN_PIPE_SB_CREATE_REQ_PEP_SUB_TYPE, 147 PN_PIPE_SB_CONNECT_REQ_PEP_SUB_TYPE, 148 PN_PIPE_SB_REDIRECT_REQ_PEP_SUB_TYPE, 149 PN_PIPE_SB_NEGOTIATED_FC, 150 PN_PIPE_SB_REQUIRED_FC_TX, 151 PN_PIPE_SB_PREFERRED_FC_RX, 152 PN_PIPE_SB_ALIGNED_DATA, 153 }; 154 155 /* Phonet pipe flow control models */ 156 enum { 157 PN_NO_FLOW_CONTROL, 158 PN_LEGACY_FLOW_CONTROL, 159 PN_ONE_CREDIT_FLOW_CONTROL, 160 PN_MULTI_CREDIT_FLOW_CONTROL, 161 }; 162 163 #define pn_flow_safe(fc) ((fc) >> 1) 164 165 /* Phonet pipe flow control states */ 166 enum { 167 PEP_IND_EMPTY, 168 PEP_IND_BUSY, 169 PEP_IND_READY, 170 }; 171 172 #ifdef CONFIG_PHONET_PIPECTRLR 173 #define PNS_PEP_CONNECT_UTID 0x02 174 #define PNS_PIPE_CREATED_IND_UTID 0x04 175 #define PNS_PIPE_ENABLE_UTID 0x0A 176 #define PNS_PIPE_ENABLED_IND_UTID 0x0C 177 #define PNS_PIPE_DISABLE_UTID 0x0F 178 #define PNS_PIPE_DISABLED_IND_UTID 0x11 179 #define PNS_PEP_DISCONNECT_UTID 0x06 180 181 /* Used for tracking state of a pipe */ 182 enum { 183 PIPE_IDLE, 184 PIPE_DISABLED, 185 PIPE_ENABLED, 186 }; 187 #endif /* CONFIG_PHONET_PIPECTRLR */ 188 189 #endif 190