[deliverable/linux.git] / include / linux / firewire-cdev.h

/*
 * Char device interface.
 *
 * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.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.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef _LINUX_FIREWIRE_CDEV_H
#define _LINUX_FIREWIRE_CDEV_H

#include <linux/ioctl.h>
#include <linux/types.h>
#include <linux/firewire-constants.h>

#define FW_CDEV_EVENT_BUS_RESET		0x00
#define FW_CDEV_EVENT_RESPONSE		0x01
#define FW_CDEV_EVENT_REQUEST		0x02
#define FW_CDEV_EVENT_ISO_INTERRUPT	0x03

/* The 'closure' fields are for user space to use.  Data passed in the
 * 'closure' field for a request will be returned in the corresponding
 * event.  It's a 64-bit type so that it's a fixed size type big
 * enough to hold a pointer on all platforms. */

struct fw_cdev_event_common {
	__u64 closure;
	__u32 type;
};

struct fw_cdev_event_bus_reset {
	__u64 closure;
	__u32 type;
	__u32 node_id;
	__u32 local_node_id;
	__u32 bm_node_id;
	__u32 irm_node_id;
	__u32 root_node_id;
	__u32 generation;
};

struct fw_cdev_event_response {
	__u64 closure;
	__u32 type;
	__u32 rcode;
	__u32 length;
	__u32 data[0];
};

struct fw_cdev_event_request {
	__u64 closure;
	__u32 type;
	__u32 tcode;
	__u64 offset;
	__u32 handle;
	__u32 length;
	__u32 data[0];
};

struct fw_cdev_event_iso_interrupt {
	__u64 closure;
	__u32 type;
	__u32 cycle;
	__u32 header_length;	/* Length in bytes of following headers. */
	__u32 header[0];
};

union fw_cdev_event {
	struct fw_cdev_event_common common;
	struct fw_cdev_event_bus_reset bus_reset;
	struct fw_cdev_event_response response;
	struct fw_cdev_event_request request;
	struct fw_cdev_event_iso_interrupt iso_interrupt;
};

#define FW_CDEV_IOC_GET_INFO		_IOWR('#', 0x00, struct fw_cdev_get_info)
#define FW_CDEV_IOC_SEND_REQUEST	_IOW('#', 0x01, struct fw_cdev_send_request)
#define FW_CDEV_IOC_ALLOCATE		_IOWR('#', 0x02, struct fw_cdev_allocate)
#define FW_CDEV_IOC_DEALLOCATE		_IOW('#', 0x03, struct fw_cdev_deallocate)
#define FW_CDEV_IOC_SEND_RESPONSE	_IOW('#', 0x04, struct fw_cdev_send_response)
#define FW_CDEV_IOC_INITIATE_BUS_RESET	_IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
#define FW_CDEV_IOC_ADD_DESCRIPTOR	_IOWR('#', 0x06, struct fw_cdev_add_descriptor)
#define FW_CDEV_IOC_REMOVE_DESCRIPTOR	_IOW('#', 0x07, struct fw_cdev_remove_descriptor)

#define FW_CDEV_IOC_CREATE_ISO_CONTEXT	_IOWR('#', 0x08, struct fw_cdev_create_iso_context)
#define FW_CDEV_IOC_QUEUE_ISO		_IOWR('#', 0x09, struct fw_cdev_queue_iso)
#define FW_CDEV_IOC_START_ISO		_IOW('#', 0x0a, struct fw_cdev_start_iso)
#define FW_CDEV_IOC_STOP_ISO		_IOW('#', 0x0b, struct fw_cdev_stop_iso)

/* FW_CDEV_VERSION History
 *
 * 1	Feb 18, 2007:  Initial version.
 */
#define FW_CDEV_VERSION		1

struct fw_cdev_get_info {
	/* The version field is just a running serial number.  We
	 * never break backwards compatibility.  Userspace passes in
	 * the version it expects and the kernel passes back the
	 * highest version it can provide.  Even if the structs in
	 * this interface are extended in a later version, the kernel
	 * will not copy back more data than what was present in the
	 * interface version userspace expects. */
	__u32 version;

	/* If non-zero, at most rom_length bytes of config rom will be
	 * copied into that user space address.  In either case,
	 * rom_length is updated with the actual length of the config
	 * rom. */
	__u32 rom_length;
	__u64 rom;

	/* If non-zero, a fw_cdev_event_bus_reset struct will be
	 * copied here with the current state of the bus.  This does
	 * not cause a bus reset to happen.  The value of closure in
	 * this and sub-sequent bus reset events is set to
	 * bus_reset_closure. */
	__u64 bus_reset;
	__u64 bus_reset_closure;

	/* The index of the card this devices belongs to. */
	__u32 card;
};

struct fw_cdev_send_request {
	__u32 tcode;
	__u32 length;
	__u64 offset;
	__u64 closure;
	__u64 data;
	__u32 generation;
};

struct fw_cdev_send_response {
	__u32 rcode;
	__u32 length;
	__u64 data;
	__u32 handle;
};

struct fw_cdev_allocate {
	__u64 offset;
	__u64 closure;
	__u32 length;
	__u32 handle;
};

struct fw_cdev_deallocate {
	__u32 handle;
};

#define FW_CDEV_LONG_RESET	0
#define FW_CDEV_SHORT_RESET	1

struct fw_cdev_initiate_bus_reset {
	__u32 type;
};

struct fw_cdev_add_descriptor {
	__u32 immediate;
	__u32 key;
	__u64 data;
	__u32 length;
	__u32 handle;
};

struct fw_cdev_remove_descriptor {
	__u32 handle;
};

#define FW_CDEV_ISO_CONTEXT_TRANSMIT	0
#define FW_CDEV_ISO_CONTEXT_RECEIVE	1

#define FW_CDEV_ISO_CONTEXT_MATCH_TAG0		 1
#define FW_CDEV_ISO_CONTEXT_MATCH_TAG1		 2
#define FW_CDEV_ISO_CONTEXT_MATCH_TAG2		 4
#define FW_CDEV_ISO_CONTEXT_MATCH_TAG3		 8
#define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS	15

struct fw_cdev_create_iso_context {
	__u32 type;
	__u32 header_size;
	__u32 channel;
	__u32 speed;
	__u64 closure;
	__u32 handle;
};

struct fw_cdev_iso_packet {
	__u16 payload_length;	/* Length of indirect payload. */
	__u32 interrupt : 1;	/* Generate interrupt on this packet */
	__u32 skip : 1;		/* Set to not send packet at all. */
	__u32 tag : 2;
	__u32 sy : 4;
	__u32 header_length : 8;	/* Length of immediate header. */
	__u32 header[0];
};

struct fw_cdev_queue_iso {
	__u64 packets;
	__u64 data;
	__u32 size;
	__u32 handle;
};

struct fw_cdev_start_iso {
	__s32 cycle;
	__u32 sync;
	__u32 tags;
	__u32 handle;
};

struct fw_cdev_stop_iso {
	__u32 handle;
};

#endif /* _LINUX_FIREWIRE_CDEV_H */
Commit	Line	Data
4c5a443e KH	1	/*
4c5a443e KH	2	* Char device interface.
19a15b93 KH	3	*
	4	* Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software Foundation,
	18	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*/
	20
4c5a443e KH	21	#ifndef _LINUX_FIREWIRE_CDEV_H
4c5a443e KH	22	#define _LINUX_FIREWIRE_CDEV_H
19a15b93	23
04dfb8db KH	24	#include <linux/ioctl.h>
04dfb8db KH	25	#include <linux/types.h>
4c5a443e	26	#include <linux/firewire-constants.h>
19a15b93	27
97bd9efa KH	28	#define FW_CDEV_EVENT_BUS_RESET 0x00
	29	#define FW_CDEV_EVENT_RESPONSE 0x01
	30	#define FW_CDEV_EVENT_REQUEST 0x02
	31	#define FW_CDEV_EVENT_ISO_INTERRUPT 0x03
19a15b93 KH	32
	33	/* The 'closure' fields are for user space to use. Data passed in the
	34	* 'closure' field for a request will be returned in the corresponding
	35	* event. It's a 64-bit type so that it's a fixed size type big
	36	* enough to hold a pointer on all platforms. */
	37
da8ecffa KH	38	struct fw_cdev_event_common {
	39	__u64 closure;
	40	__u32 type;
	41	};
	42
97bd9efa	43	struct fw_cdev_event_bus_reset {
da8ecffa	44	__u64 closure;
97bd9efa KH	45	__u32 type;
	46	__u32 node_id;
	47	__u32 local_node_id;
	48	__u32 bm_node_id;
	49	__u32 irm_node_id;
	50	__u32 root_node_id;
	51	__u32 generation;
	52	};
	53
19a15b93	54	struct fw_cdev_event_response {
da8ecffa	55	__u64 closure;
19a15b93 KH	56	__u32 type;
19a15b93 KH	57	__u32 rcode;
19a15b93 KH	58	__u32 length;
	59	__u32 data[0];
	60	};
	61
	62	struct fw_cdev_event_request {
da8ecffa	63	__u64 closure;
19a15b93 KH	64	__u32 type;
	65	__u32 tcode;
	66	__u64 offset;
3964a449	67	__u32 handle;
19a15b93 KH	68	__u32 length;
	69	__u32 data[0];
	70	};
	71
	72	struct fw_cdev_event_iso_interrupt {
da8ecffa	73	__u64 closure;
19a15b93 KH	74	__u32 type;
19a15b93 KH	75	__u32 cycle;
9b32d5f3 KH	76	__u32 header_length; /* Length in bytes of following headers. */
9b32d5f3 KH	77	__u32 header[0];
19a15b93 KH	78	};
19a15b93 KH	79
da8ecffa KH	80	union fw_cdev_event {
	81	struct fw_cdev_event_common common;
	82	struct fw_cdev_event_bus_reset bus_reset;
	83	struct fw_cdev_event_response response;
	84	struct fw_cdev_event_request request;
	85	struct fw_cdev_event_iso_interrupt iso_interrupt;
	86	};
	87
4f259223 KH	88	#define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
	89	#define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
	90	#define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
	91	#define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
	92	#define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
	93	#define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
	94	#define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
	95	#define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
	96
abaa5743	97	#define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
4f259223 KH	98	#define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
4f259223 KH	99	#define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
abaa5743	100	#define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
19a15b93	101
344bbc4d KH	102	/* FW_CDEV_VERSION History
	103	*
	104	* 1 Feb 18, 2007: Initial version.
	105	*/
	106	#define FW_CDEV_VERSION 1
	107
	108	struct fw_cdev_get_info {
	109	/* The version field is just a running serial number. We
	110	* never break backwards compatibility. Userspace passes in
	111	* the version it expects and the kernel passes back the
	112	* highest version it can provide. Even if the structs in
	113	* this interface are extended in a later version, the kernel
	114	* will not copy back more data than what was present in the
	115	* interface version userspace expects. */
	116	__u32 version;
	117
	118	/* If non-zero, at most rom_length bytes of config rom will be
	119	* copied into that user space address. In either case,
	120	* rom_length is updated with the actual length of the config
	121	* rom. */
	122	__u32 rom_length;
	123	__u64 rom;
	124
	125	/* If non-zero, a fw_cdev_event_bus_reset struct will be
da8ecffa KH	126	* copied here with the current state of the bus. This does
	127	* not cause a bus reset to happen. The value of closure in
	128	* this and sub-sequent bus reset events is set to
	129	* bus_reset_closure. */
344bbc4d	130	__u64 bus_reset;
da8ecffa	131	__u64 bus_reset_closure;
e7533505 KH	132
	133	/* The index of the card this devices belongs to. */
	134	__u32 card;
19a15b93 KH	135	};
	136
	137	struct fw_cdev_send_request {
	138	__u32 tcode;
	139	__u32 length;
	140	__u64 offset;
	141	__u64 closure;
	142	__u64 data;
97e35275	143	__u32 generation;
19a15b93 KH	144	};
	145
	146	struct fw_cdev_send_response {
	147	__u32 rcode;
	148	__u32 length;
	149	__u64 data;
3964a449	150	__u32 handle;
19a15b93 KH	151	};
	152
	153	struct fw_cdev_allocate {
	154	__u64 offset;
	155	__u64 closure;
	156	__u32 length;
3964a449	157	__u32 handle;
19a15b93 KH	158	};
19a15b93 KH	159
9472316b	160	struct fw_cdev_deallocate {
3964a449	161	__u32 handle;
9472316b KH	162	};
9472316b KH	163
5371842b KH	164	#define FW_CDEV_LONG_RESET 0
	165	#define FW_CDEV_SHORT_RESET 1
	166
	167	struct fw_cdev_initiate_bus_reset {
	168	__u32 type;
	169	};
	170
66dea3e5 KH	171	struct fw_cdev_add_descriptor {
	172	__u32 immediate;
	173	__u32 key;
	174	__u64 data;
	175	__u32 length;
	176	__u32 handle;
	177	};
	178
	179	struct fw_cdev_remove_descriptor {
	180	__u32 handle;
	181	};
	182
295e3feb KH	183	#define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
	184	#define FW_CDEV_ISO_CONTEXT_RECEIVE 1
	185
98b6cbe8 KH	186	#define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
	187	#define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
	188	#define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
	189	#define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
	190	#define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
	191
19a15b93	192	struct fw_cdev_create_iso_context {
295e3feb KH	193	__u32 type;
295e3feb KH	194	__u32 header_size;
21efb3cf KH	195	__u32 channel;
21efb3cf KH	196	__u32 speed;
abaa5743 KH	197	__u64 closure;
abaa5743 KH	198	__u32 handle;
19a15b93 KH	199	};
	200
	201	struct fw_cdev_iso_packet {
5e20c282	202	__u16 payload_length; /* Length of indirect payload. */
19a15b93 KH	203	__u32 interrupt : 1; /* Generate interrupt on this packet */
	204	__u32 skip : 1; /* Set to not send packet at all. */
	205	__u32 tag : 2;
	206	__u32 sy : 4;
	207	__u32 header_length : 8; /* Length of immediate header. */
5e20c282	208	__u32 header[0];
19a15b93 KH	209	};
	210
	211	struct fw_cdev_queue_iso {
19a15b93 KH	212	__u64 packets;
19a15b93 KH	213	__u64 data;
da8ecffa	214	__u32 size;
abaa5743	215	__u32 handle;
19a15b93 KH	216	};
19a15b93 KH	217
69cdb726	218	struct fw_cdev_start_iso {
19a15b93	219	__s32 cycle;
eb0306ea KH	220	__u32 sync;
eb0306ea KH	221	__u32 tags;
abaa5743 KH	222	__u32 handle;
	223	};
	224
	225	struct fw_cdev_stop_iso {
	226	__u32 handle;
19a15b93 KH	227	};
19a15b93 KH	228
4c5a443e	229	#endif /* _LINUX_FIREWIRE_CDEV_H */