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