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