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 }; 48 49 static inline struct pep_sock *pep_sk(struct sock *sk) 50 { 51 return (struct pep_sock *)sk; 52 } 53 54 extern const struct proto_ops phonet_stream_ops; 55 56 /* Pipe protocol definitions */ 57 struct pnpipehdr { 58 u8 utid; /* transaction ID */ 59 u8 message_id; 60 u8 pipe_handle; 61 union { 62 u8 state_after_connect; /* connect request */ 63 u8 state_after_reset; /* reset request */ 64 u8 error_code; /* any response */ 65 u8 pep_type; /* status indication */ 66 u8 data[1]; 67 }; 68 }; 69 #define other_pep_type data[1] 70 71 static inline struct pnpipehdr *pnp_hdr(struct sk_buff *skb) 72 { 73 return (struct pnpipehdr *)skb_transport_header(skb); 74 } 75 76 #define MAX_PNPIPE_HEADER (MAX_PHONET_HEADER + 4) 77 78 enum { 79 PNS_PIPE_DATA = 0x20, 80 81 PNS_PEP_CONNECT_REQ = 0x40, 82 PNS_PEP_CONNECT_RESP, 83 PNS_PEP_DISCONNECT_REQ, 84 PNS_PEP_DISCONNECT_RESP, 85 PNS_PEP_RESET_REQ, 86 PNS_PEP_RESET_RESP, 87 PNS_PEP_ENABLE_REQ, 88 PNS_PEP_ENABLE_RESP, 89 PNS_PEP_CTRL_REQ, 90 PNS_PEP_CTRL_RESP, 91 PNS_PEP_DISABLE_REQ = 0x4C, 92 PNS_PEP_DISABLE_RESP, 93 94 PNS_PEP_STATUS_IND = 0x60, 95 PNS_PIPE_CREATED_IND, 96 PNS_PIPE_RESET_IND = 0x63, 97 PNS_PIPE_ENABLED_IND, 98 PNS_PIPE_REDIRECTED_IND, 99 PNS_PIPE_DISABLED_IND = 0x66, 100 }; 101 102 #define PN_PIPE_INVALID_HANDLE 0xff 103 #define PN_PEP_TYPE_COMMON 0x00 104 105 /* Phonet pipe status indication */ 106 enum { 107 PN_PEP_IND_FLOW_CONTROL, 108 PN_PEP_IND_ID_MCFC_GRANT_CREDITS, 109 }; 110 111 /* Phonet pipe error codes */ 112 enum { 113 PN_PIPE_NO_ERROR, 114 PN_PIPE_ERR_INVALID_PARAM, 115 PN_PIPE_ERR_INVALID_HANDLE, 116 PN_PIPE_ERR_INVALID_CTRL_ID, 117 PN_PIPE_ERR_NOT_ALLOWED, 118 PN_PIPE_ERR_PEP_IN_USE, 119 PN_PIPE_ERR_OVERLOAD, 120 PN_PIPE_ERR_DEV_DISCONNECTED, 121 PN_PIPE_ERR_TIMEOUT, 122 PN_PIPE_ERR_ALL_PIPES_IN_USE, 123 PN_PIPE_ERR_GENERAL, 124 PN_PIPE_ERR_NOT_SUPPORTED, 125 }; 126 127 /* Phonet pipe states */ 128 enum { 129 PN_PIPE_DISABLE, 130 PN_PIPE_ENABLE, 131 }; 132 133 /* Phonet pipe sub-block types */ 134 enum { 135 PN_PIPE_SB_CREATE_REQ_PEP_SUB_TYPE, 136 PN_PIPE_SB_CONNECT_REQ_PEP_SUB_TYPE, 137 PN_PIPE_SB_REDIRECT_REQ_PEP_SUB_TYPE, 138 PN_PIPE_SB_NEGOTIATED_FC, 139 PN_PIPE_SB_REQUIRED_FC_TX, 140 PN_PIPE_SB_PREFERRED_FC_RX, 141 }; 142 143 /* Phonet pipe flow control models */ 144 enum { 145 PN_NO_FLOW_CONTROL, 146 PN_LEGACY_FLOW_CONTROL, 147 PN_ONE_CREDIT_FLOW_CONTROL, 148 PN_MULTI_CREDIT_FLOW_CONTROL, 149 }; 150 151 #define pn_flow_safe(fc) ((fc) >> 1) 152 153 /* Phonet pipe flow control states */ 154 enum { 155 PEP_IND_EMPTY, 156 PEP_IND_BUSY, 157 PEP_IND_READY, 158 }; 159 160 #endif 161