blob: 18b20c28a4068a3a8214acc6934e292c13bbe9e6 [file] [log] [blame]
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001/* -*- 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
36#define TCODE_LOCK_REQUEST 9
37#define TCODE_STREAM_DATA 10
38#define TCODE_LOCK_RESPONSE 11
39
40#define RCODE_COMPLETE 0x0
41#define RCODE_CONFLICT_ERROR 0x4
42#define RCODE_DATA_ERROR 0x5
43#define RCODE_TYPE_ERROR 0x6
44#define RCODE_ADDRESS_ERROR 0x7
45
46#define SCODE_100 0x0
47#define SCODE_200 0x1
48#define SCODE_400 0x2
49#define SCODE_800 0x3
50#define SCODE_1600 0x4
51#define SCODE_3200 0x5
52
53#define FW_CDEV_EVENT_RESPONSE 0x00
54#define FW_CDEV_EVENT_REQUEST 0x01
55#define FW_CDEV_EVENT_ISO_INTERRUPT 0x02
56
57/* The 'closure' fields are for user space to use. Data passed in the
58 * 'closure' field for a request will be returned in the corresponding
59 * event. It's a 64-bit type so that it's a fixed size type big
60 * enough to hold a pointer on all platforms. */
61
62struct fw_cdev_event_response {
63 __u32 type;
64 __u32 rcode;
65 __u64 closure;
66 __u32 length;
67 __u32 data[0];
68};
69
70struct fw_cdev_event_request {
71 __u32 type;
72 __u32 tcode;
73 __u64 offset;
74 __u64 closure;
75 __u32 serial;
76 __u32 length;
77 __u32 data[0];
78};
79
80struct fw_cdev_event_iso_interrupt {
81 __u32 type;
82 __u32 cycle;
83 __u64 closure;
84};
85
86#define FW_CDEV_IOC_GET_CONFIG_ROM _IOR('#', 0x00, struct fw_cdev_get_config_rom)
87#define FW_CDEV_IOC_SEND_REQUEST _IO('#', 0x01)
88#define FW_CDEV_IOC_ALLOCATE _IO('#', 0x02)
89#define FW_CDEV_IOC_SEND_RESPONSE _IO('#', 0x03)
90#define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IO('#', 0x04)
91#define FW_CDEV_IOC_QUEUE_ISO _IO('#', 0x05)
92#define FW_CDEV_IOC_SEND_ISO _IO('#', 0x06)
93
94struct fw_cdev_get_config_rom {
95 __u32 length;
96 __u32 data[256];
97};
98
99struct fw_cdev_send_request {
100 __u32 tcode;
101 __u32 length;
102 __u64 offset;
103 __u64 closure;
104 __u64 data;
105};
106
107struct fw_cdev_send_response {
108 __u32 rcode;
109 __u32 length;
110 __u64 data;
111 __u32 serial;
112};
113
114struct fw_cdev_allocate {
115 __u64 offset;
116 __u64 closure;
117 __u32 length;
118};
119
120struct fw_cdev_create_iso_context {
121 __u32 buffer_size;
122};
123
124struct fw_cdev_iso_packet {
125 __u16 payload_length; /* Length of indirect payload. */
126 __u32 interrupt : 1; /* Generate interrupt on this packet */
127 __u32 skip : 1; /* Set to not send packet at all. */
128 __u32 tag : 2;
129 __u32 sy : 4;
130 __u32 header_length : 8; /* Length of immediate header. */
131 __u32 header[0];
132};
133
134struct fw_cdev_queue_iso {
135 __u32 size;
136 __u64 packets;
137 __u64 data;
138};
139
140struct fw_cdev_send_iso {
141 __u32 channel;
142 __u32 speed;
143 __s32 cycle;
144};
145
146#endif