[linux-2.6-block.git] / drivers / w1 / w1_netlink.h

/*
 * Copyright (c) 2003 Evgeniy Polyakov <zbr@ioremap.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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.
 */

#ifndef __W1_NETLINK_H
#define __W1_NETLINK_H

#include <asm/types.h>
#include <linux/connector.h>

#include "w1_internal.h"

/**
 * enum w1_cn_msg_flags - bitfield flags for struct cn_msg.flags
 *
 * @W1_CN_BUNDLE: Request bundling replies into fewer messagse.  Be prepared
 * to handle multiple struct cn_msg, struct w1_netlink_msg, and
 * struct w1_netlink_cmd in one packet.
 */
enum w1_cn_msg_flags {
	W1_CN_BUNDLE = 1,
};

/**
 * enum w1_netlink_message_types - message type
 *
 * @W1_SLAVE_ADD: notification that a slave device was added
 * @W1_SLAVE_REMOVE: notification that a slave device was removed
 * @W1_MASTER_ADD: notification that a new bus master was added
 * @W1_MASTER_REMOVE: notification that a bus masterwas removed
 * @W1_MASTER_CMD: initiate operations on a specific master
 * @W1_SLAVE_CMD: sends reset, selects the slave, then does a read/write/touch
 * operation
 * @W1_LIST_MASTERS: used to determine the bus master identifiers
 */
enum w1_netlink_message_types {
	W1_SLAVE_ADD = 0,
	W1_SLAVE_REMOVE,
	W1_MASTER_ADD,
	W1_MASTER_REMOVE,
	W1_MASTER_CMD,
	W1_SLAVE_CMD,
	W1_LIST_MASTERS,
};

/**
 * struct w1_netlink_msg - holds w1 message type, id, and result
 *
 * @type: one of enum w1_netlink_message_types
 * @status: kernel feedback for success 0 or errno failure value
 * @len: length of data following w1_netlink_msg
 * @id: union holding bus master id (msg.id) and slave device id (id[8]).
 * @id.id: Slave ID (8 bytes)
 * @id.mst: bus master identification
 * @id.mst.id: bus master ID
 * @id.mst.res: bus master reserved
 * @data: start address of any following data
 *
 * The base message structure for w1 messages over netlink.
 * The netlink connector data sequence is, struct nlmsghdr, struct cn_msg,
 * then one or more struct w1_netlink_msg (each with optional data).
 */
struct w1_netlink_msg
{
	__u8				type;
	__u8				status;
	__u16				len;
	union {
		__u8			id[8];
		struct w1_mst {
			__u32		id;
			__u32		res;
		} mst;
	} id;
	__u8				data[0];
};

/**
 * enum w1_commands - commands available for master or slave operations
 *
 * @W1_CMD_READ: read len bytes
 * @W1_CMD_WRITE: write len bytes
 * @W1_CMD_SEARCH: initiate a standard search, returns only the slave
 * devices found during that search
 * @W1_CMD_ALARM_SEARCH: search for devices that are currently alarming
 * @W1_CMD_TOUCH: Touches a series of bytes.
 * @W1_CMD_RESET: sends a bus reset on the given master
 * @W1_CMD_SLAVE_ADD: adds a slave to the given master,
 * 8 byte slave id at data[0]
 * @W1_CMD_SLAVE_REMOVE: removes a slave to the given master,
 * 8 byte slave id at data[0]
 * @W1_CMD_LIST_SLAVES: list of slaves registered on this master
 * @W1_CMD_MAX: number of available commands
 */
enum w1_commands {
	W1_CMD_READ = 0,
	W1_CMD_WRITE,
	W1_CMD_SEARCH,
	W1_CMD_ALARM_SEARCH,
	W1_CMD_TOUCH,
	W1_CMD_RESET,
	W1_CMD_SLAVE_ADD,
	W1_CMD_SLAVE_REMOVE,
	W1_CMD_LIST_SLAVES,
	W1_CMD_MAX
};

/**
 * struct w1_netlink_cmd - holds the command and data
 *
 * @cmd: one of enum w1_commands
 * @res: reserved
 * @len: length of data following w1_netlink_cmd
 * @data: start address of any following data
 *
 * One or more struct w1_netlink_cmd is placed starting at w1_netlink_msg.data
 * each with optional data.
 */
struct w1_netlink_cmd
{
	__u8				cmd;
	__u8				res;
	__u16				len;
	__u8				data[0];
};

#ifdef __KERNEL__

void w1_netlink_send(struct w1_master *, struct w1_netlink_msg *);
int w1_init_netlink(void);
void w1_fini_netlink(void);

#endif /* __KERNEL__ */
#endif /* __W1_NETLINK_H */
Commit	Line	Data
1da177e4	1	/*
a8018766	2	* Copyright (c) 2003 Evgeniy Polyakov <zbr@ioremap.net>
1da177e4	3	*
1da177e4 LT	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4 LT	13	*/
	14
	15	#ifndef __W1_NETLINK_H
	16	#define __W1_NETLINK_H
	17
	18	#include <asm/types.h>
12003375	19	#include <linux/connector.h>
1da177e4	20
de0d6dbd	21	#include "w1_internal.h"
1da177e4	22
8a0427d1 DF	23	/**
	24	* enum w1_cn_msg_flags - bitfield flags for struct cn_msg.flags
	25	*
	26	* @W1_CN_BUNDLE: Request bundling replies into fewer messagse. Be prepared
	27	* to handle multiple struct cn_msg, struct w1_netlink_msg, and
	28	* struct w1_netlink_cmd in one packet.
	29	*/
	30	enum w1_cn_msg_flags {
	31	W1_CN_BUNDLE = 1,
	32	};
	33
b3be177a DF	34	/**
b3be177a DF	35	* enum w1_netlink_message_types - message type
70b34d2e DF	36	*
	37	* @W1_SLAVE_ADD: notification that a slave device was added
	38	* @W1_SLAVE_REMOVE: notification that a slave device was removed
	39	* @W1_MASTER_ADD: notification that a new bus master was added
	40	* @W1_MASTER_REMOVE: notification that a bus masterwas removed
	41	* @W1_MASTER_CMD: initiate operations on a specific master
	42	* @W1_SLAVE_CMD: sends reset, selects the slave, then does a read/write/touch
	43	* operation
	44	* @W1_LIST_MASTERS: used to determine the bus master identifiers
	45	*/
1da177e4 LT	46	enum w1_netlink_message_types {
	47	W1_SLAVE_ADD = 0,
	48	W1_SLAVE_REMOVE,
	49	W1_MASTER_ADD,
	50	W1_MASTER_REMOVE,
12003375 EP	51	W1_MASTER_CMD,
12003375 EP	52	W1_SLAVE_CMD,
610705e7	53	W1_LIST_MASTERS,
1da177e4 LT	54	};
1da177e4 LT	55
8a0427d1 DF	56	/**
	57	* struct w1_netlink_msg - holds w1 message type, id, and result
	58	*
	59	* @type: one of enum w1_netlink_message_types
	60	* @status: kernel feedback for success 0 or errno failure value
	61	* @len: length of data following w1_netlink_msg
aa931b44 MCC	62	* @id: union holding bus master id (msg.id) and slave device id (id[8]).
	63	* @id.id: Slave ID (8 bytes)
	64	* @id.mst: bus master identification
	65	* @id.mst.id: bus master ID
	66	* @id.mst.res: bus master reserved
8a0427d1 DF	67	* @data: start address of any following data
	68	*
	69	* The base message structure for w1 messages over netlink.
	70	* The netlink connector data sequence is, struct nlmsghdr, struct cn_msg,
	71	* then one or more struct w1_netlink_msg (each with optional data).
	72	*/
7785925d	73	struct w1_netlink_msg
1da177e4 LT	74	{
1da177e4 LT	75	__u8 type;
4037014e	76	__u8 status;
12003375 EP	77	__u16 len;
	78	union {
	79	__u8 id[8];
	80	struct w1_mst {
1da177e4	81	__u32 id;
12003375	82	__u32 res;
1da177e4 LT	83	} mst;
1da177e4 LT	84	} id;
12003375 EP	85	__u8 data[0];
	86	};
	87
b3be177a DF	88	/**
b3be177a DF	89	* enum w1_commands - commands available for master or slave operations
8a0427d1	90	*
70b34d2e DF	91	* @W1_CMD_READ: read len bytes
	92	* @W1_CMD_WRITE: write len bytes
	93	* @W1_CMD_SEARCH: initiate a standard search, returns only the slave
	94	* devices found during that search
	95	* @W1_CMD_ALARM_SEARCH: search for devices that are currently alarming
	96	* @W1_CMD_TOUCH: Touches a series of bytes.
	97	* @W1_CMD_RESET: sends a bus reset on the given master
	98	* @W1_CMD_SLAVE_ADD: adds a slave to the given master,
	99	* 8 byte slave id at data[0]
	100	* @W1_CMD_SLAVE_REMOVE: removes a slave to the given master,
	101	* 8 byte slave id at data[0]
	102	* @W1_CMD_LIST_SLAVES: list of slaves registered on this master
	103	* @W1_CMD_MAX: number of available commands
	104	*/
325a06fb EP	105	enum w1_commands {
	106	W1_CMD_READ = 0,
	107	W1_CMD_WRITE,
	108	W1_CMD_SEARCH,
	109	W1_CMD_ALARM_SEARCH,
	110	W1_CMD_TOUCH,
f89735c4	111	W1_CMD_RESET,
70b34d2e DF	112	W1_CMD_SLAVE_ADD,
	113	W1_CMD_SLAVE_REMOVE,
	114	W1_CMD_LIST_SLAVES,
	115	W1_CMD_MAX
325a06fb	116	};
12003375	117
8a0427d1 DF	118	/**
	119	* struct w1_netlink_cmd - holds the command and data
	120	*
	121	* @cmd: one of enum w1_commands
	122	* @res: reserved
	123	* @len: length of data following w1_netlink_cmd
	124	* @data: start address of any following data
	125	*
	126	* One or more struct w1_netlink_cmd is placed starting at w1_netlink_msg.data
	127	* each with optional data.
	128	*/
12003375 EP	129	struct w1_netlink_cmd
	130	{
	131	__u8 cmd;
	132	__u8 res;
	133	__u16 len;
	134	__u8 data[0];
1da177e4 LT	135	};
	136
	137	#ifdef __KERNEL__
	138
	139	void w1_netlink_send(struct w1_master , struct w1_netlink_msg );
12003375 EP	140	int w1_init_netlink(void);
12003375 EP	141	void w1_fini_netlink(void);
1da177e4 LT	142
	143	#endif /* __KERNEL__ */
	144	#endif /* __W1_NETLINK_H */