xref: /linux/drivers/firewire/ohci.h (revision 6fdcba32711044c35c0e1b094cbd8f3f0b4472c9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _FIREWIRE_OHCI_H
3 #define _FIREWIRE_OHCI_H
4 
5 /* OHCI register map */
6 
7 #define OHCI1394_Version                      0x000
8 #define OHCI1394_GUID_ROM                     0x004
9 #define OHCI1394_ATRetries                    0x008
10 #define OHCI1394_CSRData                      0x00C
11 #define OHCI1394_CSRCompareData               0x010
12 #define OHCI1394_CSRControl                   0x014
13 #define OHCI1394_ConfigROMhdr                 0x018
14 #define OHCI1394_BusID                        0x01C
15 #define OHCI1394_BusOptions                   0x020
16 #define OHCI1394_GUIDHi                       0x024
17 #define OHCI1394_GUIDLo                       0x028
18 #define OHCI1394_ConfigROMmap                 0x034
19 #define OHCI1394_PostedWriteAddressLo         0x038
20 #define OHCI1394_PostedWriteAddressHi         0x03C
21 #define OHCI1394_VendorID                     0x040
22 #define OHCI1394_HCControlSet                 0x050
23 #define OHCI1394_HCControlClear               0x054
24 #define  OHCI1394_HCControl_BIBimageValid	0x80000000
25 #define  OHCI1394_HCControl_noByteSwapData	0x40000000
26 #define  OHCI1394_HCControl_programPhyEnable	0x00800000
27 #define  OHCI1394_HCControl_aPhyEnhanceEnable	0x00400000
28 #define  OHCI1394_HCControl_LPS			0x00080000
29 #define  OHCI1394_HCControl_postedWriteEnable	0x00040000
30 #define  OHCI1394_HCControl_linkEnable		0x00020000
31 #define  OHCI1394_HCControl_softReset		0x00010000
32 #define OHCI1394_SelfIDBuffer                 0x064
33 #define OHCI1394_SelfIDCount                  0x068
34 #define  OHCI1394_SelfIDCount_selfIDError	0x80000000
35 #define OHCI1394_IRMultiChanMaskHiSet         0x070
36 #define OHCI1394_IRMultiChanMaskHiClear       0x074
37 #define OHCI1394_IRMultiChanMaskLoSet         0x078
38 #define OHCI1394_IRMultiChanMaskLoClear       0x07C
39 #define OHCI1394_IntEventSet                  0x080
40 #define OHCI1394_IntEventClear                0x084
41 #define OHCI1394_IntMaskSet                   0x088
42 #define OHCI1394_IntMaskClear                 0x08C
43 #define OHCI1394_IsoXmitIntEventSet           0x090
44 #define OHCI1394_IsoXmitIntEventClear         0x094
45 #define OHCI1394_IsoXmitIntMaskSet            0x098
46 #define OHCI1394_IsoXmitIntMaskClear          0x09C
47 #define OHCI1394_IsoRecvIntEventSet           0x0A0
48 #define OHCI1394_IsoRecvIntEventClear         0x0A4
49 #define OHCI1394_IsoRecvIntMaskSet            0x0A8
50 #define OHCI1394_IsoRecvIntMaskClear          0x0AC
51 #define OHCI1394_InitialBandwidthAvailable    0x0B0
52 #define OHCI1394_InitialChannelsAvailableHi   0x0B4
53 #define OHCI1394_InitialChannelsAvailableLo   0x0B8
54 #define OHCI1394_FairnessControl              0x0DC
55 #define OHCI1394_LinkControlSet               0x0E0
56 #define OHCI1394_LinkControlClear             0x0E4
57 #define   OHCI1394_LinkControl_rcvSelfID	(1 << 9)
58 #define   OHCI1394_LinkControl_rcvPhyPkt	(1 << 10)
59 #define   OHCI1394_LinkControl_cycleTimerEnable	(1 << 20)
60 #define   OHCI1394_LinkControl_cycleMaster	(1 << 21)
61 #define   OHCI1394_LinkControl_cycleSource	(1 << 22)
62 #define OHCI1394_NodeID                       0x0E8
63 #define   OHCI1394_NodeID_idValid             0x80000000
64 #define   OHCI1394_NodeID_root                0x40000000
65 #define   OHCI1394_NodeID_nodeNumber          0x0000003f
66 #define   OHCI1394_NodeID_busNumber           0x0000ffc0
67 #define OHCI1394_PhyControl                   0x0EC
68 #define   OHCI1394_PhyControl_Read(addr)	(((addr) << 8) | 0x00008000)
69 #define   OHCI1394_PhyControl_ReadDone		0x80000000
70 #define   OHCI1394_PhyControl_ReadData(r)	(((r) & 0x00ff0000) >> 16)
71 #define   OHCI1394_PhyControl_Write(addr, data)	(((addr) << 8) | (data) | 0x00004000)
72 #define   OHCI1394_PhyControl_WritePending	0x00004000
73 #define OHCI1394_IsochronousCycleTimer        0x0F0
74 #define OHCI1394_AsReqFilterHiSet             0x100
75 #define OHCI1394_AsReqFilterHiClear           0x104
76 #define OHCI1394_AsReqFilterLoSet             0x108
77 #define OHCI1394_AsReqFilterLoClear           0x10C
78 #define OHCI1394_PhyReqFilterHiSet            0x110
79 #define OHCI1394_PhyReqFilterHiClear          0x114
80 #define OHCI1394_PhyReqFilterLoSet            0x118
81 #define OHCI1394_PhyReqFilterLoClear          0x11C
82 #define OHCI1394_PhyUpperBound                0x120
83 
84 #define OHCI1394_AsReqTrContextBase           0x180
85 #define OHCI1394_AsReqTrContextControlSet     0x180
86 #define OHCI1394_AsReqTrContextControlClear   0x184
87 #define OHCI1394_AsReqTrCommandPtr            0x18C
88 
89 #define OHCI1394_AsRspTrContextBase           0x1A0
90 #define OHCI1394_AsRspTrContextControlSet     0x1A0
91 #define OHCI1394_AsRspTrContextControlClear   0x1A4
92 #define OHCI1394_AsRspTrCommandPtr            0x1AC
93 
94 #define OHCI1394_AsReqRcvContextBase          0x1C0
95 #define OHCI1394_AsReqRcvContextControlSet    0x1C0
96 #define OHCI1394_AsReqRcvContextControlClear  0x1C4
97 #define OHCI1394_AsReqRcvCommandPtr           0x1CC
98 
99 #define OHCI1394_AsRspRcvContextBase          0x1E0
100 #define OHCI1394_AsRspRcvContextControlSet    0x1E0
101 #define OHCI1394_AsRspRcvContextControlClear  0x1E4
102 #define OHCI1394_AsRspRcvCommandPtr           0x1EC
103 
104 /* Isochronous transmit registers */
105 #define OHCI1394_IsoXmitContextBase(n)           (0x200 + 16 * (n))
106 #define OHCI1394_IsoXmitContextControlSet(n)     (0x200 + 16 * (n))
107 #define OHCI1394_IsoXmitContextControlClear(n)   (0x204 + 16 * (n))
108 #define OHCI1394_IsoXmitCommandPtr(n)            (0x20C + 16 * (n))
109 
110 /* Isochronous receive registers */
111 #define OHCI1394_IsoRcvContextBase(n)         (0x400 + 32 * (n))
112 #define OHCI1394_IsoRcvContextControlSet(n)   (0x400 + 32 * (n))
113 #define OHCI1394_IsoRcvContextControlClear(n) (0x404 + 32 * (n))
114 #define OHCI1394_IsoRcvCommandPtr(n)          (0x40C + 32 * (n))
115 #define OHCI1394_IsoRcvContextMatch(n)        (0x410 + 32 * (n))
116 
117 /* Interrupts Mask/Events */
118 #define OHCI1394_reqTxComplete		0x00000001
119 #define OHCI1394_respTxComplete		0x00000002
120 #define OHCI1394_ARRQ			0x00000004
121 #define OHCI1394_ARRS			0x00000008
122 #define OHCI1394_RQPkt			0x00000010
123 #define OHCI1394_RSPkt			0x00000020
124 #define OHCI1394_isochTx		0x00000040
125 #define OHCI1394_isochRx		0x00000080
126 #define OHCI1394_postedWriteErr		0x00000100
127 #define OHCI1394_lockRespErr		0x00000200
128 #define OHCI1394_selfIDComplete		0x00010000
129 #define OHCI1394_busReset		0x00020000
130 #define OHCI1394_regAccessFail		0x00040000
131 #define OHCI1394_phy			0x00080000
132 #define OHCI1394_cycleSynch		0x00100000
133 #define OHCI1394_cycle64Seconds		0x00200000
134 #define OHCI1394_cycleLost		0x00400000
135 #define OHCI1394_cycleInconsistent	0x00800000
136 #define OHCI1394_unrecoverableError	0x01000000
137 #define OHCI1394_cycleTooLong		0x02000000
138 #define OHCI1394_phyRegRcvd		0x04000000
139 #define OHCI1394_masterIntEnable	0x80000000
140 
141 #define OHCI1394_evt_no_status		0x0
142 #define OHCI1394_evt_long_packet	0x2
143 #define OHCI1394_evt_missing_ack	0x3
144 #define OHCI1394_evt_underrun		0x4
145 #define OHCI1394_evt_overrun		0x5
146 #define OHCI1394_evt_descriptor_read	0x6
147 #define OHCI1394_evt_data_read		0x7
148 #define OHCI1394_evt_data_write		0x8
149 #define OHCI1394_evt_bus_reset		0x9
150 #define OHCI1394_evt_timeout		0xa
151 #define OHCI1394_evt_tcode_err		0xb
152 #define OHCI1394_evt_reserved_b		0xc
153 #define OHCI1394_evt_reserved_c		0xd
154 #define OHCI1394_evt_unknown		0xe
155 #define OHCI1394_evt_flushed		0xf
156 
157 #define OHCI1394_phy_tcode		0xe
158 
159 #endif /* _FIREWIRE_OHCI_H */
160