[deliverable/linux.git] / include / linux / phonet.h

/**
 * file phonet.h
 *
 * Phonet sockets kernel interface
 *
 * Copyright (C) 2008 Nokia Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef LINUX_PHONET_H
#define LINUX_PHONET_H

/* Automatic protocol selection */
#define PN_PROTO_TRANSPORT	0
/* Phonet datagram socket */
#define PN_PROTO_PHONET		1
/* Phonet pipe */
#define PN_PROTO_PIPE		2
#define PHONET_NPROTO		3

/* Socket options for SOL_PNPIPE level */
#define PNPIPE_ENCAP		1
#define PNPIPE_IFINDEX		2

#define PNADDR_ANY		0
#define PNPORT_RESOURCE_ROUTING	0

/* Values for PNPIPE_ENCAP option */
#define PNPIPE_ENCAP_NONE	0
#define PNPIPE_ENCAP_IP		1

/* ioctls */
#define SIOCPNGETOBJECT		(SIOCPROTOPRIVATE + 0)

/* Phonet protocol header */
struct phonethdr {
	__u8	pn_rdev;
	__u8	pn_sdev;
	__u8	pn_res;
	__be16	pn_length;
	__u8	pn_robj;
	__u8	pn_sobj;
} __attribute__((packed));

/* Common Phonet payload header */
struct phonetmsg {
	__u8	pn_trans_id;	/* transaction ID */
	__u8	pn_msg_id;	/* message type */
	union {
		struct {
			__u8	pn_submsg_id;	/* message subtype */
			__u8	pn_data[5];
		} base;
		struct {
			__u16	pn_e_res_id;	/* extended resource ID */
			__u8	pn_e_submsg_id;	/* message subtype */
			__u8	pn_e_data[3];
		} ext;
	} pn_msg_u;
};
#define PN_COMMON_MESSAGE	0xF0
#define PN_COMMGR		0x10
#define PN_PREFIX		0xE0 /* resource for extended messages */
#define pn_submsg_id		pn_msg_u.base.pn_submsg_id
#define pn_e_submsg_id		pn_msg_u.ext.pn_e_submsg_id
#define pn_e_res_id		pn_msg_u.ext.pn_e_res_id
#define pn_data			pn_msg_u.base.pn_data
#define pn_e_data		pn_msg_u.ext.pn_e_data

/* data for unreachable errors */
#define PN_COMM_SERVICE_NOT_IDENTIFIED_RESP	0x01
#define PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP	0x14
#define pn_orig_msg_id		pn_data[0]
#define pn_status		pn_data[1]
#define pn_e_orig_msg_id	pn_e_data[0]
#define pn_e_status		pn_e_data[1]

/* Phonet socket address structure */
struct sockaddr_pn {
	sa_family_t spn_family;
	__u8 spn_obj;
	__u8 spn_dev;
	__u8 spn_resource;
	__u8 spn_zero[sizeof(struct sockaddr) - sizeof(sa_family_t) - 3];
} __attribute__ ((packed));

static inline __u16 pn_object(__u8 addr, __u16 port)
{
	return (addr << 8) | (port & 0x3ff);
}

static inline __u8 pn_obj(__u16 handle)
{
	return handle & 0xff;
}

static inline __u8 pn_dev(__u16 handle)
{
	return handle >> 8;
}

static inline __u16 pn_port(__u16 handle)
{
	return handle & 0x3ff;
}

static inline __u8 pn_addr(__u16 handle)
{
	return (handle >> 8) & 0xfc;
}

static inline void pn_sockaddr_set_addr(struct sockaddr_pn *spn, __u8 addr)
{
	spn->spn_dev &= 0x03;
	spn->spn_dev |= addr & 0xfc;
}

static inline void pn_sockaddr_set_port(struct sockaddr_pn *spn, __u16 port)
{
	spn->spn_dev &= 0xfc;
	spn->spn_dev |= (port >> 8) & 0x03;
	spn->spn_obj = port & 0xff;
}

static inline void pn_sockaddr_set_object(struct sockaddr_pn *spn,
						__u16 handle)
{
	spn->spn_dev = pn_dev(handle);
	spn->spn_obj = pn_obj(handle);
}

static inline void pn_sockaddr_set_resource(struct sockaddr_pn *spn,
						__u8 resource)
{
	spn->spn_resource = resource;
}

static inline __u8 pn_sockaddr_get_addr(const struct sockaddr_pn *spn)
{
	return spn->spn_dev & 0xfc;
}

static inline __u16 pn_sockaddr_get_port(const struct sockaddr_pn *spn)
{
	return ((spn->spn_dev & 0x03) << 8) | spn->spn_obj;
}

static inline __u16 pn_sockaddr_get_object(const struct sockaddr_pn *spn)
{
	return pn_object(spn->spn_dev, spn->spn_obj);
}

static inline __u8 pn_sockaddr_get_resource(const struct sockaddr_pn *spn)
{
	return spn->spn_resource;
}

#endif
Commit	Line	Data
bce7b154 RDC	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	/* Automatic protocol selection */
	27	#define PN_PROTO_TRANSPORT 0
	28	/* Phonet datagram socket */
	29	#define PN_PROTO_PHONET 1
9641458d RDC	30	/* Phonet pipe */
	31	#define PN_PROTO_PIPE 2
	32	#define PHONET_NPROTO 3
bce7b154	33
02a47617 RDC	34	/* Socket options for SOL_PNPIPE level */
	35	#define PNPIPE_ENCAP 1
	36	#define PNPIPE_IFINDEX 2
	37
bce7b154 RDC	38	#define PNADDR_ANY 0
	39	#define PNPORT_RESOURCE_ROUTING 0
	40
02a47617 RDC	41	/* Values for PNPIPE_ENCAP option */
	42	#define PNPIPE_ENCAP_NONE 0
	43	#define PNPIPE_ENCAP_IP 1
	44
ba113a94 RDC	45	/* ioctls */
	46	#define SIOCPNGETOBJECT (SIOCPROTOPRIVATE + 0)
	47
bce7b154 RDC	48	/* Phonet protocol header */
	49	struct phonethdr {
	50	__u8 pn_rdev;
	51	__u8 pn_sdev;
	52	__u8 pn_res;
	53	__be16 pn_length;
	54	__u8 pn_robj;
	55	__u8 pn_sobj;
	56	} __attribute__((packed));
	57
be0c52bf RDC	58	/* Common Phonet payload header */
	59	struct phonetmsg {
	60	__u8 pn_trans_id; /* transaction ID */
	61	__u8 pn_msg_id; /* message type */
	62	union {
	63	struct {
	64	__u8 pn_submsg_id; /* message subtype */
	65	__u8 pn_data[5];
	66	} base;
	67	struct {
	68	__u16 pn_e_res_id; /* extended resource ID */
	69	__u8 pn_e_submsg_id; /* message subtype */
	70	__u8 pn_e_data[3];
	71	} ext;
	72	} pn_msg_u;
	73	};
	74	#define PN_COMMON_MESSAGE 0xF0
c3a90c78	75	#define PN_COMMGR 0x10
be0c52bf RDC	76	#define PN_PREFIX 0xE0 /* resource for extended messages */
	77	#define pn_submsg_id pn_msg_u.base.pn_submsg_id
	78	#define pn_e_submsg_id pn_msg_u.ext.pn_e_submsg_id
	79	#define pn_e_res_id pn_msg_u.ext.pn_e_res_id
	80	#define pn_data pn_msg_u.base.pn_data
	81	#define pn_e_data pn_msg_u.ext.pn_e_data
	82
	83	/* data for unreachable errors */
	84	#define PN_COMM_SERVICE_NOT_IDENTIFIED_RESP 0x01
	85	#define PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP 0x14
	86	#define pn_orig_msg_id pn_data[0]
	87	#define pn_status pn_data[1]
	88	#define pn_e_orig_msg_id pn_e_data[0]
	89	#define pn_e_status pn_e_data[1]
	90
bce7b154 RDC	91	/* Phonet socket address structure */
	92	struct sockaddr_pn {
	93	sa_family_t spn_family;
	94	__u8 spn_obj;
	95	__u8 spn_dev;
	96	__u8 spn_resource;
	97	__u8 spn_zero[sizeof(struct sockaddr) - sizeof(sa_family_t) - 3];
	98	} __attribute__ ((packed));
	99
	100	static inline __u16 pn_object(__u8 addr, __u16 port)
	101	{
	102	return (addr << 8) \| (port & 0x3ff);
	103	}
	104
	105	static inline __u8 pn_obj(__u16 handle)
	106	{
	107	return handle & 0xff;
	108	}
	109
	110	static inline __u8 pn_dev(__u16 handle)
	111	{
	112	return handle >> 8;
	113	}
	114
	115	static inline __u16 pn_port(__u16 handle)
	116	{
	117	return handle & 0x3ff;
	118	}
	119
	120	static inline __u8 pn_addr(__u16 handle)
	121	{
	122	return (handle >> 8) & 0xfc;
	123	}
	124
	125	static inline void pn_sockaddr_set_addr(struct sockaddr_pn *spn, __u8 addr)
	126	{
	127	spn->spn_dev &= 0x03;
	128	spn->spn_dev \|= addr & 0xfc;
	129	}
	130
	131	static inline void pn_sockaddr_set_port(struct sockaddr_pn *spn, __u16 port)
	132	{
	133	spn->spn_dev &= 0xfc;
	134	spn->spn_dev \|= (port >> 8) & 0x03;
	135	spn->spn_obj = port & 0xff;
	136	}
	137
	138	static inline void pn_sockaddr_set_object(struct sockaddr_pn *spn,
	139	__u16 handle)
	140	{
	141	spn->spn_dev = pn_dev(handle);
	142	spn->spn_obj = pn_obj(handle);
	143	}
	144
	145	static inline void pn_sockaddr_set_resource(struct sockaddr_pn *spn,
	146	__u8 resource)
	147	{
	148	spn->spn_resource = resource;
	149	}
	150
	151	static inline __u8 pn_sockaddr_get_addr(const struct sockaddr_pn *spn)
	152	{
	153	return spn->spn_dev & 0xfc;
	154	}
155
156	static inline __u16 pn_sockaddr_get_port(const struct sockaddr_pn *spn)
157	{
158	return ((spn->spn_dev & 0x03) << 8) \| spn->spn_obj;
159	}
160
161	static inline __u16 pn_sockaddr_get_object(const struct sockaddr_pn *spn)
162	{
163	return pn_object(spn->spn_dev, spn->spn_obj);
164	}
165
166	static inline __u8 pn_sockaddr_get_resource(const struct sockaddr_pn *spn)
167	{
168	return spn->spn_resource;
169	}
170
171	#endif