ohci1394.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:11k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * ohci1394.h - driver for OHCI 1394 boards
  3.  * Copyright (C)1999,2000 Sebastien Rougeaux <sebastien.rougeaux@anu.edu.au>
  4.  *                        Gord Peters <GordPeters@smarttech.com>
  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. #ifndef _OHCI1394_H
  21. #define _OHCI1394_H
  22. #include "ieee1394_types.h"
  23. #define OHCI1394_DRIVER_NAME      "ohci1394"
  24. #define OHCI1394_MAX_AT_REQ_RETRIES 0x2
  25. #define OHCI1394_MAX_AT_RESP_RETRIES 0x2
  26. #define OHCI1394_MAX_PHYS_RESP_RETRIES 0x8
  27. #define OHCI1394_MAX_SELF_ID_ERRORS 16
  28. #define AR_REQ_NUM_DESC 4 /* number of AR req descriptors */
  29. #define AR_REQ_BUF_SIZE PAGE_SIZE /* size of AR req buffers */
  30. #define AR_REQ_SPLIT_BUF_SIZE PAGE_SIZE /* split packet buffer */
  31. #define AR_RESP_NUM_DESC 4 /* number of AR resp descriptors */
  32. #define AR_RESP_BUF_SIZE PAGE_SIZE /* size of AR resp buffers */
  33. #define AR_RESP_SPLIT_BUF_SIZE PAGE_SIZE /* split packet buffer */
  34. #define IR_NUM_DESC 16 /* number of IR descriptors */
  35. #define IR_BUF_SIZE PAGE_SIZE /* 4096 bytes/buffer */
  36. #define IR_SPLIT_BUF_SIZE PAGE_SIZE /* split packet buffer */
  37. #define IT_NUM_DESC 16 /* number of IT descriptors */
  38. #define AT_REQ_NUM_DESC 32 /* number of AT req descriptors */
  39. #define AT_RESP_NUM_DESC 32 /* number of AT resp descriptors */
  40. #define OHCI_LOOP_COUNT 100 /* Number of loops for reg read waits */
  41. #define OHCI_CONFIG_ROM_LEN 1024 /* Length of the mapped configrom space */
  42. #define OHCI1394_SI_DMA_BUF_SIZE 8192 /* length of the selfid buffer */
  43. /* PCI configuration space addresses */
  44. #define OHCI1394_PCI_HCI_Control 0x40
  45. struct dma_cmd {
  46.         u32 control;
  47.         u32 address;
  48.         u32 branchAddress;
  49.         u32 status;
  50. };
  51. /*
  52.  * FIXME:
  53.  * It is important that a single at_dma_prg does not cross a page boundary
  54.  * The proper way to do it would be to do the check dynamically as the
  55.  * programs are inserted into the AT fifo.
  56.  */
  57. struct at_dma_prg {
  58. struct dma_cmd begin;
  59. quadlet_t data[4];
  60. struct dma_cmd end;
  61. quadlet_t pad[4]; /* FIXME: quick hack for memory alignment */
  62. };
  63. /* DMA receive context */
  64. struct dma_rcv_ctx {
  65. void *ohci;
  66. int ctx;
  67. unsigned int num_desc;
  68. unsigned int buf_size;
  69. unsigned int split_buf_size;
  70. /* dma block descriptors */
  71.         struct dma_cmd **prg_cpu;
  72.         dma_addr_t *prg_bus;
  73. /* dma buffers */
  74.         quadlet_t **buf_cpu;
  75.         dma_addr_t *buf_bus;
  76.         unsigned int buf_ind;
  77.         unsigned int buf_offset;
  78.         quadlet_t *spb;
  79.         spinlock_t lock;
  80.         struct tasklet_struct task;
  81. int ctrlClear;
  82. int ctrlSet;
  83. int cmdPtr;
  84. };
  85. /* DMA transmit context */
  86. struct dma_trm_ctx {
  87. void *ohci;
  88. int ctx;
  89. unsigned int num_desc;
  90. /* dma block descriptors */
  91.         struct at_dma_prg **prg_cpu;
  92. dma_addr_t *prg_bus;
  93.         unsigned int prg_ind;
  94.         unsigned int sent_ind;
  95. int free_prgs;
  96.         quadlet_t *branchAddrPtr;
  97. /* list of packets inserted in the AT FIFO */
  98.         struct hpsb_packet *fifo_first;
  99.         struct hpsb_packet *fifo_last;
  100. /* list of pending packets to be inserted in the AT FIFO */
  101.         struct hpsb_packet *pending_first;
  102.         struct hpsb_packet *pending_last;
  103.         spinlock_t lock;
  104.         struct tasklet_struct task;
  105. int ctrlClear;
  106. int ctrlSet;
  107. int cmdPtr;
  108. };
  109. /* video device template */
  110. struct video_template {
  111. void (*irq_handler) (int card, quadlet_t isoRecvEvent, 
  112.      quadlet_t isoXmitEvent);
  113. };
  114. struct ti_ohci {
  115.         int id; /* sequential card number */
  116. struct list_head list;
  117.         struct pci_dev *dev;
  118.         u32 state;
  119.         
  120.         /* remapped memory spaces */
  121.         void *registers; 
  122. /* dma buffer for self-id packets */
  123.         quadlet_t *selfid_buf_cpu;
  124.         dma_addr_t selfid_buf_bus;
  125. /* buffer for csr config rom */
  126.         quadlet_t *csr_config_rom_cpu; 
  127.         dma_addr_t csr_config_rom_bus; 
  128. int csr_config_rom_length;
  129. unsigned int max_packet_size;
  130.         /* async receive */
  131. struct dma_rcv_ctx *ar_resp_context;
  132. struct dma_rcv_ctx *ar_req_context;
  133. /* async transmit */
  134. struct dma_trm_ctx *at_resp_context;
  135. struct dma_trm_ctx *at_req_context;
  136.         /* iso receive */
  137. struct dma_rcv_ctx *ir_context;
  138.         spinlock_t IR_channel_lock;
  139. int nb_iso_rcv_ctx;
  140.         /* iso transmit */
  141. struct dma_trm_ctx *it_context;
  142. int nb_iso_xmit_ctx;
  143.         u64 ISO_channel_usage;
  144.         /* IEEE-1394 part follows */
  145.         struct hpsb_host *host;
  146.         int phyid, isroot;
  147.         spinlock_t phy_reg_lock;
  148. spinlock_t event_lock;
  149. int self_id_errors;
  150. /* video device */
  151. struct video_template *video_tmpl;
  152. /* Swap the selfid buffer? */
  153. unsigned int selfid_swap:1;
  154. /* Some Apple chipset seem to swap incoming headers for us */
  155. unsigned int no_swap_incoming:1;
  156. };
  157. static inline int cross_bound(unsigned long addr, unsigned int size)
  158. {
  159. int cross=0;
  160. if (size>PAGE_SIZE) {
  161. cross = size/PAGE_SIZE;
  162. size -= cross*PAGE_SIZE;
  163. }
  164. if ((PAGE_SIZE-addr%PAGE_SIZE)<size)
  165. cross++;
  166. return cross;
  167. }
  168. /*
  169.  * Register read and write helper functions.
  170.  */
  171. static inline void reg_write(const struct ti_ohci *ohci, int offset, u32 data)
  172. {
  173.         writel(data, ohci->registers + offset);
  174. }
  175. static inline u32 reg_read(const struct ti_ohci *ohci, int offset)
  176. {
  177.         return readl(ohci->registers + offset);
  178. }
  179. /* 2 KiloBytes of register space */
  180. #define OHCI1394_REGISTER_SIZE                0x800       
  181. /* register map */
  182. #define OHCI1394_Version                      0x000
  183. #define OHCI1394_GUID_ROM                     0x004
  184. #define OHCI1394_ATRetries                    0x008
  185. #define OHCI1394_CSRData                      0x00C
  186. #define OHCI1394_CSRCompareData               0x010
  187. #define OHCI1394_CSRControl                   0x014
  188. #define OHCI1394_ConfigROMhdr                 0x018
  189. #define OHCI1394_BusID                        0x01C
  190. #define OHCI1394_BusOptions                   0x020
  191. #define OHCI1394_GUIDHi                       0x024
  192. #define OHCI1394_GUIDLo                       0x028
  193. #define OHCI1394_ConfigROMmap                 0x034
  194. #define OHCI1394_PostedWriteAddressLo         0x038
  195. #define OHCI1394_PostedWriteAddressHi         0x03C
  196. #define OHCI1394_VendorID                     0x040
  197. #define OHCI1394_HCControlSet                 0x050
  198. #define OHCI1394_HCControlClear               0x054
  199. #define OHCI1394_SelfIDBuffer                 0x064
  200. #define OHCI1394_SelfIDCount                  0x068
  201. #define OHCI1394_IRMultiChanMaskHiSet         0x070
  202. #define OHCI1394_IRMultiChanMaskHiClear       0x074
  203. #define OHCI1394_IRMultiChanMaskLoSet         0x078
  204. #define OHCI1394_IRMultiChanMaskLoClear       0x07C
  205. #define OHCI1394_IntEventSet                  0x080
  206. #define OHCI1394_IntEventClear                0x084
  207. #define OHCI1394_IntMaskSet                   0x088
  208. #define OHCI1394_IntMaskClear                 0x08C
  209. #define OHCI1394_IsoXmitIntEventSet           0x090
  210. #define OHCI1394_IsoXmitIntEventClear         0x094
  211. #define OHCI1394_IsoXmitIntMaskSet            0x098
  212. #define OHCI1394_IsoXmitIntMaskClear          0x09C
  213. #define OHCI1394_IsoRecvIntEventSet           0x0A0
  214. #define OHCI1394_IsoRecvIntEventClear         0x0A4
  215. #define OHCI1394_IsoRecvIntMaskSet            0x0A8
  216. #define OHCI1394_IsoRecvIntMaskClear          0x0AC
  217. #define OHCI1394_FairnessControl              0x0DC
  218. #define OHCI1394_LinkControlSet               0x0E0
  219. #define OHCI1394_LinkControlClear             0x0E4
  220. #define OHCI1394_NodeID                       0x0E8
  221. #define OHCI1394_PhyControl                   0x0EC
  222. #define OHCI1394_IsochronousCycleTimer        0x0F0
  223. #define OHCI1394_AsReqFilterHiSet             0x100
  224. #define OHCI1394_AsReqFilterHiClear           0x104
  225. #define OHCI1394_AsReqFilterLoSet             0x108
  226. #define OHCI1394_AsReqFilterLoClear           0x10C
  227. #define OHCI1394_PhyReqFilterHiSet            0x110
  228. #define OHCI1394_PhyReqFilterHiClear          0x114
  229. #define OHCI1394_PhyReqFilterLoSet            0x118
  230. #define OHCI1394_PhyReqFilterLoClear          0x11C
  231. #define OHCI1394_PhyUpperBound                0x120
  232. #define OHCI1394_AsReqTrContextControlSet     0x180
  233. #define OHCI1394_AsReqTrContextControlClear   0x184
  234. #define OHCI1394_AsReqTrCommandPtr            0x18C
  235. #define OHCI1394_AsRspTrContextControlSet     0x1A0
  236. #define OHCI1394_AsRspTrContextControlClear   0x1A4
  237. #define OHCI1394_AsRspTrCommandPtr            0x1AC
  238. #define OHCI1394_AsReqRcvContextControlSet    0x1C0
  239. #define OHCI1394_AsReqRcvContextControlClear  0x1C4
  240. #define OHCI1394_AsReqRcvCommandPtr           0x1CC
  241. #define OHCI1394_AsRspRcvContextControlSet    0x1E0
  242. #define OHCI1394_AsRspRcvContextControlClear  0x1E4
  243. #define OHCI1394_AsRspRcvCommandPtr           0x1EC
  244. /* Isochronous transmit registers */
  245. /* Add (32 * n) for context n */
  246. #define OHCI1394_IsoXmitContextControlSet     0x200
  247. #define OHCI1394_IsoXmitContextControlClear   0x204
  248. #define OHCI1394_IsoXmitCommandPtr            0x20C
  249. /* Isochronous receive registers */
  250. /* Add (32 * n) for context n */
  251. #define OHCI1394_IsoRcvContextControlSet      0x400
  252. #define OHCI1394_IsoRcvContextControlClear    0x404
  253. #define OHCI1394_IsoRcvCommandPtr             0x40C
  254. #define OHCI1394_IsoRcvContextMatch           0x410
  255. /* Interrupts Mask/Events */
  256. #define OHCI1394_reqTxComplete           0x00000001
  257. #define OHCI1394_respTxComplete          0x00000002
  258. #define OHCI1394_ARRQ                    0x00000004
  259. #define OHCI1394_ARRS                    0x00000008
  260. #define OHCI1394_RQPkt                   0x00000010
  261. #define OHCI1394_RSPkt                   0x00000020
  262. #define OHCI1394_isochTx                 0x00000040
  263. #define OHCI1394_isochRx                 0x00000080
  264. #define OHCI1394_postedWriteErr          0x00000100
  265. #define OHCI1394_lockRespErr             0x00000200
  266. #define OHCI1394_selfIDComplete          0x00010000
  267. #define OHCI1394_busReset                0x00020000
  268. #define OHCI1394_phy                     0x00080000
  269. #define OHCI1394_cycleSynch              0x00100000
  270. #define OHCI1394_cycle64Seconds          0x00200000
  271. #define OHCI1394_cycleLost               0x00400000
  272. #define OHCI1394_cycleInconsistent       0x00800000
  273. #define OHCI1394_unrecoverableError      0x01000000
  274. #define OHCI1394_cycleTooLong            0x02000000
  275. #define OHCI1394_phyRegRcvd              0x04000000
  276. #define OHCI1394_masterIntEnable         0x80000000
  277. /* DMA Control flags */
  278. #define DMA_CTL_OUTPUT_MORE              0x00000000
  279. #define DMA_CTL_OUTPUT_LAST              0x10000000
  280. #define DMA_CTL_INPUT_MORE               0x20000000
  281. #define DMA_CTL_INPUT_LAST               0x30000000
  282. #define DMA_CTL_UPDATE                   0x08000000
  283. #define DMA_CTL_IMMEDIATE                0x02000000
  284. #define DMA_CTL_IRQ                      0x00300000
  285. #define DMA_CTL_BRANCH                   0x000c0000
  286. #define DMA_CTL_WAIT                     0x00030000
  287. #define OHCI1394_TCODE_PHY               0xE
  288. void ohci1394_stop_context(struct ti_ohci *ohci, int reg, char *msg);
  289. struct ti_ohci *ohci1394_get_struct(int card_num);
  290. int ohci1394_register_video(struct ti_ohci *ohci,
  291.     struct video_template *tmpl);
  292. void ohci1394_unregister_video(struct ti_ohci *ohci,
  293.        struct video_template *tmpl);
  294. #endif