1 /** 2 * file phonet.h 3 * 4 * Phonet sockets kernel interface 5 * 6 * Copyright (C) 2008 Nokia Corporation. All rights reserved. 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 LINUX_PHONET_H 24 #define LINUX_PHONET_H 25 26 #include <linux/types.h> 27 28 /* Automatic protocol selection */ 29 #define PN_PROTO_TRANSPORT 0 30 /* Phonet datagram socket */ 31 #define PN_PROTO_PHONET 1 32 /* Phonet pipe */ 33 #define PN_PROTO_PIPE 2 34 #define PHONET_NPROTO 3 35 36 /* Socket options for SOL_PNPIPE level */ 37 #define PNPIPE_ENCAP 1 38 #define PNPIPE_IFINDEX 2 39 #define PNPIPE_PIPE_HANDLE 3 40 #define PNPIPE_ENABLE 4 41 /* unused slot */ 42 43 #define PNADDR_ANY 0 44 #define PNADDR_BROADCAST 0xFC 45 #define PNPORT_RESOURCE_ROUTING 0 46 47 /* Values for PNPIPE_ENCAP option */ 48 #define PNPIPE_ENCAP_NONE 0 49 #define PNPIPE_ENCAP_IP 1 50 51 /* ioctls */ 52 #define SIOCPNGETOBJECT (SIOCPROTOPRIVATE + 0) 53 #define SIOCPNADDRESOURCE (SIOCPROTOPRIVATE + 14) 54 #define SIOCPNDELRESOURCE (SIOCPROTOPRIVATE + 15) 55 56 /* Phonet protocol header */ 57 struct phonethdr { 58 __u8 pn_rdev; 59 __u8 pn_sdev; 60 __u8 pn_res; 61 __be16 pn_length; 62 __u8 pn_robj; 63 __u8 pn_sobj; 64 } __attribute__((packed)); 65 66 /* Common Phonet payload header */ 67 struct phonetmsg { 68 __u8 pn_trans_id; /* transaction ID */ 69 __u8 pn_msg_id; /* message type */ 70 union { 71 struct { 72 __u8 pn_submsg_id; /* message subtype */ 73 __u8 pn_data[5]; 74 } base; 75 struct { 76 __u16 pn_e_res_id; /* extended resource ID */ 77 __u8 pn_e_submsg_id; /* message subtype */ 78 __u8 pn_e_data[3]; 79 } ext; 80 } pn_msg_u; 81 }; 82 #define PN_COMMON_MESSAGE 0xF0 83 #define PN_COMMGR 0x10 84 #define PN_PREFIX 0xE0 /* resource for extended messages */ 85 #define pn_submsg_id pn_msg_u.base.pn_submsg_id 86 #define pn_e_submsg_id pn_msg_u.ext.pn_e_submsg_id 87 #define pn_e_res_id pn_msg_u.ext.pn_e_res_id 88 #define pn_data pn_msg_u.base.pn_data 89 #define pn_e_data pn_msg_u.ext.pn_e_data 90 91 /* data for unreachable errors */ 92 #define PN_COMM_SERVICE_NOT_IDENTIFIED_RESP 0x01 93 #define PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP 0x14 94 #define pn_orig_msg_id pn_data[0] 95 #define pn_status pn_data[1] 96 #define pn_e_orig_msg_id pn_e_data[0] 97 #define pn_e_status pn_e_data[1] 98 99 /* Phonet socket address structure */ 100 struct sockaddr_pn { 101 sa_family_t spn_family; 102 __u8 spn_obj; 103 __u8 spn_dev; 104 __u8 spn_resource; 105 __u8 spn_zero[sizeof(struct sockaddr) - sizeof(sa_family_t) - 3]; 106 } __attribute__((packed)); 107 108 /* Well known address */ 109 #define PN_DEV_PC 0x10 110 111 static inline __u16 pn_object(__u8 addr, __u16 port) 112 { 113 return (addr << 8) | (port & 0x3ff); 114 } 115 116 static inline __u8 pn_obj(__u16 handle) 117 { 118 return handle & 0xff; 119 } 120 121 static inline __u8 pn_dev(__u16 handle) 122 { 123 return handle >> 8; 124 } 125 126 static inline __u16 pn_port(__u16 handle) 127 { 128 return handle & 0x3ff; 129 } 130 131 static inline __u8 pn_addr(__u16 handle) 132 { 133 return (handle >> 8) & 0xfc; 134 } 135 136 static inline void pn_sockaddr_set_addr(struct sockaddr_pn *spn, __u8 addr) 137 { 138 spn->spn_dev &= 0x03; 139 spn->spn_dev |= addr & 0xfc; 140 } 141 142 static inline void pn_sockaddr_set_port(struct sockaddr_pn *spn, __u16 port) 143 { 144 spn->spn_dev &= 0xfc; 145 spn->spn_dev |= (port >> 8) & 0x03; 146 spn->spn_obj = port & 0xff; 147 } 148 149 static inline void pn_sockaddr_set_object(struct sockaddr_pn *spn, 150 __u16 handle) 151 { 152 spn->spn_dev = pn_dev(handle); 153 spn->spn_obj = pn_obj(handle); 154 } 155 156 static inline void pn_sockaddr_set_resource(struct sockaddr_pn *spn, 157 __u8 resource) 158 { 159 spn->spn_resource = resource; 160 } 161 162 static inline __u8 pn_sockaddr_get_addr(const struct sockaddr_pn *spn) 163 { 164 return spn->spn_dev & 0xfc; 165 } 166 167 static inline __u16 pn_sockaddr_get_port(const struct sockaddr_pn *spn) 168 { 169 return ((spn->spn_dev & 0x03) << 8) | spn->spn_obj; 170 } 171 172 static inline __u16 pn_sockaddr_get_object(const struct sockaddr_pn *spn) 173 { 174 return pn_object(spn->spn_dev, spn->spn_obj); 175 } 176 177 static inline __u8 pn_sockaddr_get_resource(const struct sockaddr_pn *spn) 178 { 179 return spn->spn_resource; 180 } 181 182 /* Phonet device ioctl requests */ 183 #ifdef __KERNEL__ 184 #define SIOCPNGAUTOCONF (SIOCDEVPRIVATE + 0) 185 186 struct if_phonet_autoconf { 187 uint8_t device; 188 }; 189 190 struct if_phonet_req { 191 char ifr_phonet_name[16]; 192 union { 193 struct if_phonet_autoconf ifru_phonet_autoconf; 194 } ifr_ifru; 195 }; 196 #define ifr_phonet_autoconf ifr_ifru.ifru_phonet_autoconf 197 #endif /* __KERNEL__ */ 198 199 #endif 200