firewire-cdev.h 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  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. #ifndef __fw_cdev_h
  22. #define __fw_cdev_h
  23. #include <linux/ioctl.h>
  24. #include <linux/types.h>
  25. #define TCODE_WRITE_QUADLET_REQUEST 0
  26. #define TCODE_WRITE_BLOCK_REQUEST 1
  27. #define TCODE_WRITE_RESPONSE 2
  28. #define TCODE_READ_QUADLET_REQUEST 4
  29. #define TCODE_READ_BLOCK_REQUEST 5
  30. #define TCODE_READ_QUADLET_RESPONSE 6
  31. #define TCODE_READ_BLOCK_RESPONSE 7
  32. #define TCODE_CYCLE_START 8
  33. #define TCODE_LOCK_REQUEST 9
  34. #define TCODE_STREAM_DATA 10
  35. #define TCODE_LOCK_RESPONSE 11
  36. #define TCODE_LOCK_MASK_SWAP 0x11
  37. #define TCODE_LOCK_COMPARE_SWAP 0x12
  38. #define TCODE_LOCK_FETCH_ADD 0x13
  39. #define TCODE_LOCK_LITTLE_ADD 0x14
  40. #define TCODE_LOCK_BOUNDED_ADD 0x15
  41. #define TCODE_LOCK_WRAP_ADD 0x16
  42. #define TCODE_LOCK_VENDOR_DEPENDENT 0x17
  43. #define RCODE_COMPLETE 0x0
  44. #define RCODE_CONFLICT_ERROR 0x4
  45. #define RCODE_DATA_ERROR 0x5
  46. #define RCODE_TYPE_ERROR 0x6
  47. #define RCODE_ADDRESS_ERROR 0x7
  48. #define RCODE_SEND_ERROR 0x10
  49. #define RCODE_CANCELLED 0x11
  50. #define RCODE_BUSY 0x12
  51. #define RCODE_GENERATION 0x13
  52. #define RCODE_NO_ACK 0x14
  53. #define SCODE_100 0x0
  54. #define SCODE_200 0x1
  55. #define SCODE_400 0x2
  56. #define SCODE_800 0x3
  57. #define SCODE_1600 0x4
  58. #define SCODE_3200 0x5
  59. #define FW_CDEV_EVENT_BUS_RESET 0x00
  60. #define FW_CDEV_EVENT_RESPONSE 0x01
  61. #define FW_CDEV_EVENT_REQUEST 0x02
  62. #define FW_CDEV_EVENT_ISO_INTERRUPT 0x03
  63. /* The 'closure' fields are for user space to use. Data passed in the
  64. * 'closure' field for a request will be returned in the corresponding
  65. * event. It's a 64-bit type so that it's a fixed size type big
  66. * enough to hold a pointer on all platforms. */
  67. struct fw_cdev_event_common {
  68. __u64 closure;
  69. __u32 type;
  70. };
  71. struct fw_cdev_event_bus_reset {
  72. __u64 closure;
  73. __u32 type;
  74. __u32 node_id;
  75. __u32 local_node_id;
  76. __u32 bm_node_id;
  77. __u32 irm_node_id;
  78. __u32 root_node_id;
  79. __u32 generation;
  80. };
  81. struct fw_cdev_event_response {
  82. __u64 closure;
  83. __u32 type;
  84. __u32 rcode;
  85. __u32 length;
  86. __u32 data[0];
  87. };
  88. struct fw_cdev_event_request {
  89. __u64 closure;
  90. __u32 type;
  91. __u32 tcode;
  92. __u64 offset;
  93. __u32 handle;
  94. __u32 length;
  95. __u32 data[0];
  96. };
  97. struct fw_cdev_event_iso_interrupt {
  98. __u64 closure;
  99. __u32 type;
  100. __u32 cycle;
  101. __u32 header_length; /* Length in bytes of following headers. */
  102. __u32 header[0];
  103. };
  104. union fw_cdev_event {
  105. struct fw_cdev_event_common common;
  106. struct fw_cdev_event_bus_reset bus_reset;
  107. struct fw_cdev_event_response response;
  108. struct fw_cdev_event_request request;
  109. struct fw_cdev_event_iso_interrupt iso_interrupt;
  110. };
  111. #define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
  112. #define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
  113. #define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
  114. #define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
  115. #define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
  116. #define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
  117. #define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
  118. #define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
  119. #define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
  120. #define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
  121. #define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
  122. #define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
  123. /* FW_CDEV_VERSION History
  124. *
  125. * 1 Feb 18, 2007: Initial version.
  126. */
  127. #define FW_CDEV_VERSION 1
  128. struct fw_cdev_get_info {
  129. /* The version field is just a running serial number. We
  130. * never break backwards compatibility. Userspace passes in
  131. * the version it expects and the kernel passes back the
  132. * highest version it can provide. Even if the structs in
  133. * this interface are extended in a later version, the kernel
  134. * will not copy back more data than what was present in the
  135. * interface version userspace expects. */
  136. __u32 version;
  137. /* If non-zero, at most rom_length bytes of config rom will be
  138. * copied into that user space address. In either case,
  139. * rom_length is updated with the actual length of the config
  140. * rom. */
  141. __u32 rom_length;
  142. __u64 rom;
  143. /* If non-zero, a fw_cdev_event_bus_reset struct will be
  144. * copied here with the current state of the bus. This does
  145. * not cause a bus reset to happen. The value of closure in
  146. * this and sub-sequent bus reset events is set to
  147. * bus_reset_closure. */
  148. __u64 bus_reset;
  149. __u64 bus_reset_closure;
  150. /* The index of the card this devices belongs to. */
  151. __u32 card;
  152. };
  153. struct fw_cdev_send_request {
  154. __u32 tcode;
  155. __u32 length;
  156. __u64 offset;
  157. __u64 closure;
  158. __u64 data;
  159. __u32 generation;
  160. };
  161. struct fw_cdev_send_response {
  162. __u32 rcode;
  163. __u32 length;
  164. __u64 data;
  165. __u32 handle;
  166. };
  167. struct fw_cdev_allocate {
  168. __u64 offset;
  169. __u64 closure;
  170. __u32 length;
  171. __u32 handle;
  172. };
  173. struct fw_cdev_deallocate {
  174. __u32 handle;
  175. };
  176. #define FW_CDEV_LONG_RESET 0
  177. #define FW_CDEV_SHORT_RESET 1
  178. struct fw_cdev_initiate_bus_reset {
  179. __u32 type;
  180. };
  181. struct fw_cdev_add_descriptor {
  182. __u32 immediate;
  183. __u32 key;
  184. __u64 data;
  185. __u32 length;
  186. __u32 handle;
  187. };
  188. struct fw_cdev_remove_descriptor {
  189. __u32 handle;
  190. };
  191. #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
  192. #define FW_CDEV_ISO_CONTEXT_RECEIVE 1
  193. #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
  194. #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
  195. #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
  196. #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
  197. #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
  198. struct fw_cdev_create_iso_context {
  199. __u32 type;
  200. __u32 header_size;
  201. __u32 channel;
  202. __u32 speed;
  203. __u64 closure;
  204. __u32 handle;
  205. };
  206. struct fw_cdev_iso_packet {
  207. __u16 payload_length; /* Length of indirect payload. */
  208. __u32 interrupt : 1; /* Generate interrupt on this packet */
  209. __u32 skip : 1; /* Set to not send packet at all. */
  210. __u32 tag : 2;
  211. __u32 sy : 4;
  212. __u32 header_length : 8; /* Length of immediate header. */
  213. __u32 header[0];
  214. };
  215. struct fw_cdev_queue_iso {
  216. __u64 packets;
  217. __u64 data;
  218. __u32 size;
  219. __u32 handle;
  220. };
  221. struct fw_cdev_start_iso {
  222. __s32 cycle;
  223. __u32 sync;
  224. __u32 tags;
  225. __u32 handle;
  226. };
  227. struct fw_cdev_stop_iso {
  228. __u32 handle;
  229. };
  230. #endif /* __fw_cdev_h */