4 * Phonet sockets kernel interface
6 * Copyright (C) 2008 Nokia Corporation. All rights reserved.
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.
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.
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
23 #ifndef LINUX_PHONET_H
24 #define LINUX_PHONET_H
26 #include <linux/types.h>
28 /* Automatic protocol selection */
29 #define PN_PROTO_TRANSPORT 0
30 /* Phonet datagram socket */
31 #define PN_PROTO_PHONET 1
33 #define PN_PROTO_PIPE 2
34 #define PHONET_NPROTO 3
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
46 #define PNADDR_BROADCAST 0xFC
47 #define PNPORT_RESOURCE_ROUTING 0
49 /* Values for PNPIPE_ENCAP option */
50 #define PNPIPE_ENCAP_NONE 0
51 #define PNPIPE_ENCAP_IP 1
54 #define SIOCPNGETOBJECT (SIOCPROTOPRIVATE + 0)
55 #define SIOCPNADDRESOURCE (SIOCPROTOPRIVATE + 14)
56 #define SIOCPNDELRESOURCE (SIOCPROTOPRIVATE + 15)
58 /* Phonet protocol header */
66 } __attribute__((packed
));
68 /* Common Phonet payload header */
70 __u8 pn_trans_id
; /* transaction ID */
71 __u8 pn_msg_id
; /* message type */
74 __u8 pn_submsg_id
; /* message subtype */
78 __u16 pn_e_res_id
; /* extended resource ID */
79 __u8 pn_e_submsg_id
; /* message subtype */
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
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]
101 /* Phonet socket address structure */
103 sa_family_t spn_family
;
107 __u8 spn_zero
[sizeof(struct sockaddr
) - sizeof(sa_family_t
) - 3];
108 } __attribute__((packed
));
110 /* Well known address */
111 #define PN_DEV_PC 0x10
113 static inline __u16
pn_object(__u8 addr
, __u16 port
)
115 return (addr
<< 8) | (port
& 0x3ff);
118 static inline __u8
pn_obj(__u16 handle
)
120 return handle
& 0xff;
123 static inline __u8
pn_dev(__u16 handle
)
128 static inline __u16
pn_port(__u16 handle
)
130 return handle
& 0x3ff;
133 static inline __u8
pn_addr(__u16 handle
)
135 return (handle
>> 8) & 0xfc;
138 static inline void pn_sockaddr_set_addr(struct sockaddr_pn
*spn
, __u8 addr
)
140 spn
->spn_dev
&= 0x03;
141 spn
->spn_dev
|= addr
& 0xfc;
144 static inline void pn_sockaddr_set_port(struct sockaddr_pn
*spn
, __u16 port
)
146 spn
->spn_dev
&= 0xfc;
147 spn
->spn_dev
|= (port
>> 8) & 0x03;
148 spn
->spn_obj
= port
& 0xff;
151 static inline void pn_sockaddr_set_object(struct sockaddr_pn
*spn
,
154 spn
->spn_dev
= pn_dev(handle
);
155 spn
->spn_obj
= pn_obj(handle
);
158 static inline void pn_sockaddr_set_resource(struct sockaddr_pn
*spn
,
161 spn
->spn_resource
= resource
;
164 static inline __u8
pn_sockaddr_get_addr(const struct sockaddr_pn
*spn
)
166 return spn
->spn_dev
& 0xfc;
169 static inline __u16
pn_sockaddr_get_port(const struct sockaddr_pn
*spn
)
171 return ((spn
->spn_dev
& 0x03) << 8) | spn
->spn_obj
;
174 static inline __u16
pn_sockaddr_get_object(const struct sockaddr_pn
*spn
)
176 return pn_object(spn
->spn_dev
, spn
->spn_obj
);
179 static inline __u8
pn_sockaddr_get_resource(const struct sockaddr_pn
*spn
)
181 return spn
->spn_resource
;
184 /* Phonet device ioctl requests */
186 #define SIOCPNGAUTOCONF (SIOCDEVPRIVATE + 0)
188 struct if_phonet_autoconf
{
192 struct if_phonet_req
{
193 char ifr_phonet_name
[16];
195 struct if_phonet_autoconf ifru_phonet_autoconf
;
198 #define ifr_phonet_autoconf ifr_ifru.ifru_phonet_autoconf
199 #endif /* __KERNEL__ */