185c10f28286148ee5cdba1d22c81936ff160596eRob Herring/**
285c10f28286148ee5cdba1d22c81936ff160596eRob Herring * file phonet.h
385c10f28286148ee5cdba1d22c81936ff160596eRob Herring *
485c10f28286148ee5cdba1d22c81936ff160596eRob Herring * Phonet sockets kernel interface
585c10f28286148ee5cdba1d22c81936ff160596eRob Herring *
685c10f28286148ee5cdba1d22c81936ff160596eRob Herring * Copyright (C) 2008 Nokia Corporation. All rights reserved.
785c10f28286148ee5cdba1d22c81936ff160596eRob Herring *
885c10f28286148ee5cdba1d22c81936ff160596eRob Herring * This program is free software; you can redistribute it and/or
985c10f28286148ee5cdba1d22c81936ff160596eRob Herring * modify it under the terms of the GNU General Public License
1085c10f28286148ee5cdba1d22c81936ff160596eRob Herring * version 2 as published by the Free Software Foundation.
1185c10f28286148ee5cdba1d22c81936ff160596eRob Herring *
1285c10f28286148ee5cdba1d22c81936ff160596eRob Herring * This program is distributed in the hope that it will be useful, but
1385c10f28286148ee5cdba1d22c81936ff160596eRob Herring * WITHOUT ANY WARRANTY; without even the implied warranty of
1485c10f28286148ee5cdba1d22c81936ff160596eRob Herring * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1585c10f28286148ee5cdba1d22c81936ff160596eRob Herring * General Public License for more details.
1685c10f28286148ee5cdba1d22c81936ff160596eRob Herring *
1785c10f28286148ee5cdba1d22c81936ff160596eRob Herring * You should have received a copy of the GNU General Public License
1885c10f28286148ee5cdba1d22c81936ff160596eRob Herring * along with this program; if not, write to the Free Software
1985c10f28286148ee5cdba1d22c81936ff160596eRob Herring * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
2085c10f28286148ee5cdba1d22c81936ff160596eRob Herring * 02110-1301 USA
2185c10f28286148ee5cdba1d22c81936ff160596eRob Herring */
2285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
2385c10f28286148ee5cdba1d22c81936ff160596eRob Herring#ifndef _UAPILINUX_PHONET_H
2485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define _UAPILINUX_PHONET_H
2585c10f28286148ee5cdba1d22c81936ff160596eRob Herring
2685c10f28286148ee5cdba1d22c81936ff160596eRob Herring#include <linux/types.h>
2785c10f28286148ee5cdba1d22c81936ff160596eRob Herring#include <linux/socket.h>
2885c10f28286148ee5cdba1d22c81936ff160596eRob Herring
2985c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Automatic protocol selection */
3085c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_PROTO_TRANSPORT	0
3185c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Phonet datagram socket */
3285c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_PROTO_PHONET		1
3385c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Phonet pipe */
3485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_PROTO_PIPE		2
3585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PHONET_NPROTO		3
3685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
3785c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Socket options for SOL_PNPIPE level */
3885c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_ENCAP		1
3985c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_IFINDEX		2
4085c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_HANDLE		3
4185c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_INITSTATE	4
4285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
4385c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNADDR_ANY		0
4485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNADDR_BROADCAST	0xFC
4585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPORT_RESOURCE_ROUTING	0
4685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
4785c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Values for PNPIPE_ENCAP option */
4885c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_ENCAP_NONE	0
4985c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PNPIPE_ENCAP_IP		1
5085c10f28286148ee5cdba1d22c81936ff160596eRob Herring
5185c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* ioctls */
5285c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define SIOCPNGETOBJECT		(SIOCPROTOPRIVATE + 0)
5385c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define SIOCPNENABLEPIPE	(SIOCPROTOPRIVATE + 13)
5485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define SIOCPNADDRESOURCE	(SIOCPROTOPRIVATE + 14)
5585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define SIOCPNDELRESOURCE	(SIOCPROTOPRIVATE + 15)
5685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
5785c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Phonet protocol header */
5885c10f28286148ee5cdba1d22c81936ff160596eRob Herringstruct phonethdr {
5985c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_rdev;
6085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_sdev;
6185c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_res;
6285c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__be16	pn_length;
6385c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_robj;
6485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_sobj;
6585c10f28286148ee5cdba1d22c81936ff160596eRob Herring} __attribute__((packed));
6685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
6785c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Common Phonet payload header */
6885c10f28286148ee5cdba1d22c81936ff160596eRob Herringstruct phonetmsg {
6985c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_trans_id;	/* transaction ID */
7085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8	pn_msg_id;	/* message type */
7185c10f28286148ee5cdba1d22c81936ff160596eRob Herring	union {
7285c10f28286148ee5cdba1d22c81936ff160596eRob Herring		struct {
7385c10f28286148ee5cdba1d22c81936ff160596eRob Herring			__u8	pn_submsg_id;	/* message subtype */
7485c10f28286148ee5cdba1d22c81936ff160596eRob Herring			__u8	pn_data[5];
7585c10f28286148ee5cdba1d22c81936ff160596eRob Herring		} base;
7685c10f28286148ee5cdba1d22c81936ff160596eRob Herring		struct {
7785c10f28286148ee5cdba1d22c81936ff160596eRob Herring			__u16	pn_e_res_id;	/* extended resource ID */
7885c10f28286148ee5cdba1d22c81936ff160596eRob Herring			__u8	pn_e_submsg_id;	/* message subtype */
7985c10f28286148ee5cdba1d22c81936ff160596eRob Herring			__u8	pn_e_data[3];
8085c10f28286148ee5cdba1d22c81936ff160596eRob Herring		} ext;
8185c10f28286148ee5cdba1d22c81936ff160596eRob Herring	} pn_msg_u;
8285c10f28286148ee5cdba1d22c81936ff160596eRob Herring};
8385c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_COMMON_MESSAGE	0xF0
8485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_COMMGR		0x10
8585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_PREFIX		0xE0 /* resource for extended messages */
8685c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_submsg_id		pn_msg_u.base.pn_submsg_id
8785c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_e_submsg_id		pn_msg_u.ext.pn_e_submsg_id
8885c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_e_res_id		pn_msg_u.ext.pn_e_res_id
8985c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_data			pn_msg_u.base.pn_data
9085c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_e_data		pn_msg_u.ext.pn_e_data
9185c10f28286148ee5cdba1d22c81936ff160596eRob Herring
9285c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* data for unreachable errors */
9385c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_COMM_SERVICE_NOT_IDENTIFIED_RESP	0x01
9485c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP	0x14
9585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_orig_msg_id		pn_data[0]
9685c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_status		pn_data[1]
9785c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_e_orig_msg_id	pn_e_data[0]
9885c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define pn_e_status		pn_e_data[1]
9985c10f28286148ee5cdba1d22c81936ff160596eRob Herring
10085c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Phonet socket address structure */
10185c10f28286148ee5cdba1d22c81936ff160596eRob Herringstruct sockaddr_pn {
10285c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__kernel_sa_family_t spn_family;
10385c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8 spn_obj;
10485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8 spn_dev;
10585c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8 spn_resource;
10685c10f28286148ee5cdba1d22c81936ff160596eRob Herring	__u8 spn_zero[sizeof(struct sockaddr) - sizeof(__kernel_sa_family_t) - 3];
10785c10f28286148ee5cdba1d22c81936ff160596eRob Herring} __attribute__((packed));
10885c10f28286148ee5cdba1d22c81936ff160596eRob Herring
10985c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Well known address */
11085c10f28286148ee5cdba1d22c81936ff160596eRob Herring#define PN_DEV_PC	0x10
11185c10f28286148ee5cdba1d22c81936ff160596eRob Herring
11285c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u16 pn_object(__u8 addr, __u16 port)
11385c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
11485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return (addr << 8) | (port & 0x3ff);
11585c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
11685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
11785c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u8 pn_obj(__u16 handle)
11885c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
11985c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return handle & 0xff;
12085c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
12185c10f28286148ee5cdba1d22c81936ff160596eRob Herring
12285c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u8 pn_dev(__u16 handle)
12385c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
12485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return handle >> 8;
12585c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
12685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
12785c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u16 pn_port(__u16 handle)
12885c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
12985c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return handle & 0x3ff;
13085c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
13185c10f28286148ee5cdba1d22c81936ff160596eRob Herring
13285c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u8 pn_addr(__u16 handle)
13385c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
13485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return (handle >> 8) & 0xfc;
13585c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
13685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
13785c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline void pn_sockaddr_set_addr(struct sockaddr_pn *spn, __u8 addr)
13885c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
13985c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_dev &= 0x03;
14085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_dev |= addr & 0xfc;
14185c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
14285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
14385c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline void pn_sockaddr_set_port(struct sockaddr_pn *spn, __u16 port)
14485c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
14585c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_dev &= 0xfc;
14685c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_dev |= (port >> 8) & 0x03;
14785c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_obj = port & 0xff;
14885c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
14985c10f28286148ee5cdba1d22c81936ff160596eRob Herring
15085c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline void pn_sockaddr_set_object(struct sockaddr_pn *spn,
15185c10f28286148ee5cdba1d22c81936ff160596eRob Herring						__u16 handle)
15285c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
15385c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_dev = pn_dev(handle);
15485c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_obj = pn_obj(handle);
15585c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
15685c10f28286148ee5cdba1d22c81936ff160596eRob Herring
15785c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline void pn_sockaddr_set_resource(struct sockaddr_pn *spn,
15885c10f28286148ee5cdba1d22c81936ff160596eRob Herring						__u8 resource)
15985c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
16085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	spn->spn_resource = resource;
16185c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
16285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
16385c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u8 pn_sockaddr_get_addr(const struct sockaddr_pn *spn)
16485c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
16585c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return spn->spn_dev & 0xfc;
166e6c3827dcfe53dd78b824d2ee4007a216ada739eRob Herring}
16785c10f28286148ee5cdba1d22c81936ff160596eRob Herring
16885c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u16 pn_sockaddr_get_port(const struct sockaddr_pn *spn)
16985c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
17085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return ((spn->spn_dev & 0x03) << 8) | spn->spn_obj;
17185c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
17285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
17385c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u16 pn_sockaddr_get_object(const struct sockaddr_pn *spn)
17485c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
17585c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return pn_object(spn->spn_dev, spn->spn_obj);
17685c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
17785c10f28286148ee5cdba1d22c81936ff160596eRob Herring
17885c10f28286148ee5cdba1d22c81936ff160596eRob Herringstatic inline __u8 pn_sockaddr_get_resource(const struct sockaddr_pn *spn)
17985c10f28286148ee5cdba1d22c81936ff160596eRob Herring{
18085c10f28286148ee5cdba1d22c81936ff160596eRob Herring	return spn->spn_resource;
18185c10f28286148ee5cdba1d22c81936ff160596eRob Herring}
18285c10f28286148ee5cdba1d22c81936ff160596eRob Herring
18385c10f28286148ee5cdba1d22c81936ff160596eRob Herring/* Phonet device ioctl requests */
18485c10f28286148ee5cdba1d22c81936ff160596eRob Herring
18585c10f28286148ee5cdba1d22c81936ff160596eRob Herring#endif /* _UAPILINUX_PHONET_H */
18685c10f28286148ee5cdba1d22c81936ff160596eRob Herring