[deliverable/linux.git] / drivers / firewire / fw-device-cdev.h

/*						-*- c-basic-offset: 8 -*-
 *
 * fw-device-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 __fw_cdev_h
#define __fw_cdev_h

#include <asm/ioctl.h>
#include <asm/types.h>

#define TCODE_WRITE_QUADLET_REQUEST	0
#define TCODE_WRITE_BLOCK_REQUEST	1
#define TCODE_WRITE_RESPONSE		2
#define TCODE_READ_QUADLET_REQUEST	4
#define TCODE_READ_BLOCK_REQUEST	5
#define TCODE_READ_QUADLET_RESPONSE	6
#define TCODE_READ_BLOCK_RESPONSE	7
#define TCODE_CYCLE_START		8
#define TCODE_LOCK_REQUEST		9
#define TCODE_STREAM_DATA		10
#define TCODE_LOCK_RESPONSE		11

#define TCODE_LOCK_MASK_SWAP		0x11
#define TCODE_LOCK_COMPARE_SWAP		0x12
#define TCODE_LOCK_FETCH_ADD		0x13
#define TCODE_LOCK_LITTLE_ADD		0x14
#define TCODE_LOCK_BOUNDED_ADD		0x15
#define TCODE_LOCK_WRAP_ADD		0x16
#define TCODE_LOCK_VENDOR_DEPENDENT	0x17

#define RCODE_COMPLETE			0x0
#define RCODE_CONFLICT_ERROR		0x4
#define RCODE_DATA_ERROR		0x5
#define RCODE_TYPE_ERROR		0x6
#define RCODE_ADDRESS_ERROR		0x7

#define RCODE_SEND_ERROR		0x10
#define RCODE_CANCELLED			0x11
#define RCODE_BUSY			0x12
#define RCODE_GENERATION		0x13
#define RCODE_NO_ACK			0x14

#define SCODE_100			0x0
#define SCODE_200			0x1
#define SCODE_400			0x2
#define SCODE_800			0x3
#define SCODE_1600			0x4
#define SCODE_3200			0x5

#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 serial;
	__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		_IO('#', 0x00)
#define FW_CDEV_IOC_SEND_REQUEST	_IO('#', 0x01)
#define FW_CDEV_IOC_ALLOCATE		_IO('#', 0x02)
#define FW_CDEV_IOC_DEALLOCATE		_IO('#', 0x03)
#define FW_CDEV_IOC_SEND_RESPONSE	_IO('#', 0x04)
#define FW_CDEV_IOC_INITIATE_BUS_RESET	_IO('#', 0x05)
#define FW_CDEV_IOC_CREATE_ISO_CONTEXT	_IO('#', 0x06)
#define FW_CDEV_IOC_QUEUE_ISO		_IO('#', 0x07)
#define FW_CDEV_IOC_START_ISO		_IO('#', 0x08)
#define FW_CDEV_IOC_STOP_ISO		_IO('#', 0x09)

/* 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 serial;
};

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

struct fw_cdev_deallocate {
	__u64 offset;
};

#define FW_CDEV_LONG_RESET	0
#define FW_CDEV_SHORT_RESET	1

struct fw_cdev_initiate_bus_reset {
	__u32 type;
};

#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;
};

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;
};

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

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