projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag '9p-for-5.1' of git://github.com/martinetd/linux
[linux-2.6-block.git] / drivers / usb / host / ohci.h
CommitLineData
5fd54ace 1// SPDX-License-Identifier: GPL-1.0+
1da177e4
LT		 2/*
3 * OHCI HCD (Host Controller Driver) for USB.
dd9048af 4 *
1da177e4
LT		 5 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
6 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
dd9048af 7 *
1da177e4
LT		 8 * This file is licenced under the GPL.
9 */
10
11/*
12 * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to
13 * __leXX (normally) or __beXX (given OHCI_BIG_ENDIAN), depending on the
14 * host controller implementation.
15 */
16typedef __u32 __bitwise __hc32;
17typedef __u16 __bitwise __hc16;
dd9048af 18
1da177e4
LT		 19/*
20 * OHCI Endpoint Descriptor (ED) ... holds TD queue
21 * See OHCI spec, section 4.2
22 *
23 * This is a "Queue Head" for those transfers, which is why
24 * both EHCI and UHCI call similar structures a "QH".
25 */
26struct ed {
27 /* first fields are hardware-specified */
dd9048af 28 __hc32 hwINFO; /* endpoint config bitmap */
1da177e4
LT		 29 /* info bits defined by hcd */
30#define ED_DEQUEUE (1 << 27)
31 /* info bits defined by the hardware */
32#define ED_ISO (1 << 15)
33#define ED_SKIP (1 << 14)
34#define ED_LOWSPEED (1 << 13)
35#define ED_OUT (0x01 << 11)
36#define ED_IN (0x02 << 11)
37 __hc32 hwTailP; /* tail of TD list */
38 __hc32 hwHeadP; /* head of TD list (hc r/w) */
39#define ED_C (0x02) /* toggle carry */
40#define ED_H (0x01) /* halted */
41 __hc32 hwNextED; /* next ED in list */
42
43 /* rest are purely for the driver's use */
44 dma_addr_t dma; /* addr of ED */
45 struct td *dummy; /* next TD to activate */
46
47 /* host's view of schedule */
48 struct ed *ed_next; /* on schedule or rm_list */
49 struct ed *ed_prev; /* for non-interrupt EDs */
50 struct list_head td_list; /* "shadow list" of our TDs */
81e38333 51 struct list_head in_use_list;
1da177e4
LT		 52
53 /* create --> IDLE --> OPER --> ... --> IDLE --> destroy
54 * usually: OPER --> UNLINK --> (IDLE | OPER) --> ...
55 */
56 u8 state; /* ED_{IDLE,UNLINK,OPER} */
dd9048af
DB		 57#define ED_IDLE 0x00 /* NOT linked to HC */
58#define ED_UNLINK 0x01 /* being unlinked from hc */
1da177e4
LT		 59#define ED_OPER 0x02 /* IS linked to hc */
60
dd9048af 61 u8 type; /* PIPE_{BULK,...} */
1da177e4
LT		 62
63 /* periodic scheduling params (for intr and iso) */
64 u8 branch;
65 u16 interval;
66 u16 load;
67 u16 last_iso; /* iso only */
68
69 /* HC may see EDs on rm_list until next frame (frame_no == tick) */
70 u16 tick;
81e38333
AS		 71
72 /* Detect TDs not added to the done queue */
73 unsigned takeback_wdh_cnt;
74 struct td *pending_td;
75#define OKAY_TO_TAKEBACK(ohci, ed) \
76 ((int) (ohci->wdh_cnt - ed->takeback_wdh_cnt) >= 0)
77
1da177e4
LT		 78} __attribute__ ((aligned(16)));
79
80#define ED_MASK ((u32)~0x0f) /* strip hw status in low addr bits */
81
dd9048af 82
1da177e4
LT		 83/*
84 * OHCI Transfer Descriptor (TD) ... one per transfer segment
85 * See OHCI spec, sections 4.3.1 (general = control/bulk/interrupt)
86 * and 4.3.2 (iso)
87 */
88struct td {
89 /* first fields are hardware-specified */
90 __hc32 hwINFO; /* transfer info bitmask */
91
92 /* hwINFO bits for both general and iso tds: */
93#define TD_CC 0xf0000000 /* condition code */
94#define TD_CC_GET(td_p) ((td_p >>28) & 0x0f)
95//#define TD_CC_SET(td_p, cc) (td_p) = ((td_p) & 0x0fffffff) | (((cc) & 0x0f) << 28)
96#define TD_DI 0x00E00000 /* frames before interrupt */
97#define TD_DI_SET(X) (((X) & 0x07)<< 21)
98 /* these two bits are available for definition/use by HCDs in both
99 * general and iso tds ... others are available for only one type
100 */
101#define TD_DONE 0x00020000 /* retired to donelist */
102#define TD_ISO 0x00010000 /* copy of ED_ISO */
103
104 /* hwINFO bits for general tds: */
105#define TD_EC 0x0C000000 /* error count */
106#define TD_T 0x03000000 /* data toggle state */
107#define TD_T_DATA0 0x02000000 /* DATA0 */
108#define TD_T_DATA1 0x03000000 /* DATA1 */
109#define TD_T_TOGGLE 0x00000000 /* uses ED_C */
110#define TD_DP 0x00180000 /* direction/pid */
111#define TD_DP_SETUP 0x00000000 /* SETUP pid */
112#define TD_DP_IN 0x00100000 /* IN pid */
113#define TD_DP_OUT 0x00080000 /* OUT pid */
114 /* 0x00180000 rsvd */
115#define TD_R 0x00040000 /* round: short packets OK? */
116
117 /* (no hwINFO #defines yet for iso tds) */
118
dd9048af
DB		 119 __hc32 hwCBP; /* Current Buffer Pointer (or 0) */
120 __hc32 hwNextTD; /* Next TD Pointer */
121 __hc32 hwBE; /* Memory Buffer End Pointer */
1da177e4
LT		 122
123 /* PSW is only for ISO. Only 1 PSW entry is used, but on
124 * big-endian PPC hardware that's the second entry.
125 */
126#define MAXPSW 2
dd9048af 127 __hc16 hwPSW [MAXPSW];
1da177e4
LT		 128
129 /* rest are purely for the driver's use */
dd9048af
DB		 130 __u8 index;
131 struct ed *ed;
132 struct td *td_hash; /* dma-->td hashtable */
133 struct td *next_dl_td;
134 struct urb *urb;
1da177e4
LT		 135
136 dma_addr_t td_dma; /* addr of this TD */
137 dma_addr_t data_dma; /* addr of data it points to */
138
139 struct list_head td_list; /* "shadow list", TDs on same ED */
140} __attribute__ ((aligned(32))); /* c/b/i need 16; only iso needs 32 */
141
142#define TD_MASK ((u32)~0x1f) /* strip hw status in low addr bits */
143
144/*
145 * Hardware transfer status codes -- CC from td->hwINFO or td->hwPSW
146 */
147#define TD_CC_NOERROR 0x00
148#define TD_CC_CRC 0x01
149#define TD_CC_BITSTUFFING 0x02
150#define TD_CC_DATATOGGLEM 0x03
151#define TD_CC_STALL 0x04
152#define TD_DEVNOTRESP 0x05
153#define TD_PIDCHECKFAIL 0x06
154#define TD_UNEXPECTEDPID 0x07
155#define TD_DATAOVERRUN 0x08
156#define TD_DATAUNDERRUN 0x09
157 /* 0x0A, 0x0B reserved for hardware */
158#define TD_BUFFEROVERRUN 0x0C
159#define TD_BUFFERUNDERRUN 0x0D
160 /* 0x0E, 0x0F reserved for HCD */
161#define TD_NOTACCESSED 0x0F
162
163
dd9048af
DB		 164/* map OHCI TD status codes (CC) to errno values */
165static const int cc_to_error [16] = {
1da177e4
LT		 166 /* No Error */ 0,
167 /* CRC Error */ -EILSEQ,
168 /* Bit Stuff */ -EPROTO,
169 /* Data Togg */ -EILSEQ,
170 /* Stall */ -EPIPE,
38e2bfc9 171 /* DevNotResp */ -ETIME,
1da177e4
LT		 172 /* PIDCheck */ -EPROTO,
173 /* UnExpPID */ -EPROTO,
174 /* DataOver */ -EOVERFLOW,
175 /* DataUnder */ -EREMOTEIO,
176 /* (for hw) */ -EIO,
177 /* (for hw) */ -EIO,
178 /* BufferOver */ -ECOMM,
179 /* BuffUnder */ -ENOSR,
180 /* (for HCD) */ -EALREADY,
dd9048af 181 /* (for HCD) */ -EALREADY
1da177e4
LT		 182};
183
184
185/*
186 * The HCCA (Host Controller Communications Area) is a 256 byte
187 * structure defined section 4.4.1 of the OHCI spec. The HC is
188 * told the base address of it. It must be 256-byte aligned.
189 */
190struct ohci_hcca {
191#define NUM_INTS 32
192 __hc32 int_table [NUM_INTS]; /* periodic schedule */
193
dd9048af 194 /*
1da177e4
LT		 195 * OHCI defines u16 frame_no, followed by u16 zero pad.
196 * Since some processors can't do 16 bit bus accesses,
197 * portable access must be a 32 bits wide.
198 */
199 __hc32 frame_no; /* current frame number */
200 __hc32 done_head; /* info returned for an interrupt */
201 u8 reserved_for_hc [116];
202 u8 what [4]; /* spec only identifies 252 bytes :) */
203} __attribute__ ((aligned(256)));
204
205/*
206 * This is the structure of the OHCI controller's memory mapped I/O region.
207 * You must use readl() and writel() (in <asm/io.h>) to access these fields!!
208 * Layout is in section 7 (and appendix B) of the spec.
209 */
210struct ohci_regs {
211 /* control and status registers (section 7.1) */
212 __hc32 revision;
213 __hc32 control;
214 __hc32 cmdstatus;
215 __hc32 intrstatus;
216 __hc32 intrenable;
217 __hc32 intrdisable;
218
219 /* memory pointers (section 7.2) */
220 __hc32 hcca;
221 __hc32 ed_periodcurrent;
222 __hc32 ed_controlhead;
223 __hc32 ed_controlcurrent;
224 __hc32 ed_bulkhead;
225 __hc32 ed_bulkcurrent;
226 __hc32 donehead;
227
228 /* frame counters (section 7.3) */
229 __hc32 fminterval;
230 __hc32 fmremaining;
231 __hc32 fmnumber;
232 __hc32 periodicstart;
233 __hc32 lsthresh;
234
235 /* Root hub ports (section 7.4) */
236 struct ohci_roothub_regs {
237 __hc32 a;
238 __hc32 b;
239 __hc32 status;
240#define MAX_ROOT_PORTS 15 /* maximum OHCI root hub ports (RH_A_NDP) */
241 __hc32 portstatus [MAX_ROOT_PORTS];
242 } roothub;
243
244 /* and optional "legacy support" registers (appendix B) at 0x0100 */
245
246} __attribute__ ((aligned(32)));
247
248
249/* OHCI CONTROL AND STATUS REGISTER MASKS */
250
251/*
252 * HcControl (control) register masks
253 */
254#define OHCI_CTRL_CBSR (3 << 0) /* control/bulk service ratio */
255#define OHCI_CTRL_PLE (1 << 2) /* periodic list enable */
256#define OHCI_CTRL_IE (1 << 3) /* isochronous enable */
257#define OHCI_CTRL_CLE (1 << 4) /* control list enable */
258#define OHCI_CTRL_BLE (1 << 5) /* bulk list enable */
259#define OHCI_CTRL_HCFS (3 << 6) /* host controller functional state */
260#define OHCI_CTRL_IR (1 << 8) /* interrupt routing */
261#define OHCI_CTRL_RWC (1 << 9) /* remote wakeup connected */
262#define OHCI_CTRL_RWE (1 << 10) /* remote wakeup enable */
263
264/* pre-shifted values for HCFS */
265# define OHCI_USB_RESET (0 << 6)
266# define OHCI_USB_RESUME (1 << 6)
267# define OHCI_USB_OPER (2 << 6)
268# define OHCI_USB_SUSPEND (3 << 6)
269
270/*
271 * HcCommandStatus (cmdstatus) register masks
272 */
273#define OHCI_HCR (1 << 0) /* host controller reset */
dd9048af
DB		 274#define OHCI_CLF (1 << 1) /* control list filled */
275#define OHCI_BLF (1 << 2) /* bulk list filled */
276#define OHCI_OCR (1 << 3) /* ownership change request */
277#define OHCI_SOC (3 << 16) /* scheduling overrun count */
1da177e4
LT		 278
279/*
280 * masks used with interrupt registers:
281 * HcInterruptStatus (intrstatus)
282 * HcInterruptEnable (intrenable)
283 * HcInterruptDisable (intrdisable)
284 */
285#define OHCI_INTR_SO (1 << 0) /* scheduling overrun */
286#define OHCI_INTR_WDH (1 << 1) /* writeback of done_head */
287#define OHCI_INTR_SF (1 << 2) /* start frame */
288#define OHCI_INTR_RD (1 << 3) /* resume detect */
289#define OHCI_INTR_UE (1 << 4) /* unrecoverable error */
290#define OHCI_INTR_FNO (1 << 5) /* frame number overflow */
291#define OHCI_INTR_RHSC (1 << 6) /* root hub status change */
292#define OHCI_INTR_OC (1 << 30) /* ownership change */
293#define OHCI_INTR_MIE (1 << 31) /* master interrupt enable */
294
295
296/* OHCI ROOT HUB REGISTER MASKS */
dd9048af 297
1da177e4 298/* roothub.portstatus [i] bits */
dd9048af
DB		 299#define RH_PS_CCS 0x00000001 /* current connect status */
300#define RH_PS_PES 0x00000002 /* port enable status*/
301#define RH_PS_PSS 0x00000004 /* port suspend status */
302#define RH_PS_POCI 0x00000008 /* port over current indicator */
303#define RH_PS_PRS 0x00000010 /* port reset status */
304#define RH_PS_PPS 0x00000100 /* port power status */
305#define RH_PS_LSDA 0x00000200 /* low speed device attached */
306#define RH_PS_CSC 0x00010000 /* connect status change */
307#define RH_PS_PESC 0x00020000 /* port enable status change */
308#define RH_PS_PSSC 0x00040000 /* port suspend status change */
309#define RH_PS_OCIC 0x00080000 /* over current indicator change */
310#define RH_PS_PRSC 0x00100000 /* port reset status change */
1da177e4
LT		 311
312/* roothub.status bits */
313#define RH_HS_LPS 0x00000001 /* local power status */
314#define RH_HS_OCI 0x00000002 /* over current indicator */
315#define RH_HS_DRWE 0x00008000 /* device remote wakeup enable */
316#define RH_HS_LPSC 0x00010000 /* local power status change */
317#define RH_HS_OCIC 0x00020000 /* over current indicator change */
318#define RH_HS_CRWE 0x80000000 /* clear remote wakeup enable */
319
320/* roothub.b masks */
321#define RH_B_DR 0x0000ffff /* device removable flags */
322#define RH_B_PPCM 0xffff0000 /* port power control mask */
323
324/* roothub.a masks */
325#define RH_A_NDP (0xff << 0) /* number of downstream ports */
326#define RH_A_PSM (1 << 8) /* power switching mode */
327#define RH_A_NPS (1 << 9) /* no power switching */
328#define RH_A_DT (1 << 10) /* device type (mbz) */
329#define RH_A_OCPM (1 << 11) /* over current protection mode */
330#define RH_A_NOCP (1 << 12) /* no over current protection */
331#define RH_A_POTPGT (0xff << 24) /* power on to power good time */
332
333
334/* hcd-private per-urb state */
335typedef struct urb_priv {
336 struct ed *ed;
337 u16 length; // # tds in this request
338 u16 td_cnt; // tds already serviced
339 struct list_head pending;
340 struct td *td [0]; // all TDs in this request
341
342} urb_priv_t;
343
344#define TD_HASH_SIZE 64 /* power'o'two */
dd9048af 345// sizeof (struct td) ~= 64 == 2^6 ...
1da177e4
LT		 346#define TD_HASH_FUNC(td_dma) ((td_dma ^ (td_dma >> 6)) % TD_HASH_SIZE)
347
348
349/*
350 * This is the full ohci controller description
351 *
352 * Note how the "proper" USB information is just
353 * a subset of what the full implementation needs. (Linus)
354 */
355
b7463c71
AS		 356enum ohci_rh_state {
357 OHCI_RH_HALTED,
358 OHCI_RH_SUSPENDED,
359 OHCI_RH_RUNNING
360};
361
1da177e4
LT		 362struct ohci_hcd {
363 spinlock_t lock;
364
365 /*
366 * I/O memory used to communicate with the HC (dma-consistent)
367 */
368 struct ohci_regs __iomem *regs;
369
370 /*
371 * main memory used to communicate with the HC (dma-consistent).
372 * hcd adds to schedule for a live hc any time, but removals finish
373 * only at the start of the next frame.
374 */
375 struct ohci_hcca *hcca;
376 dma_addr_t hcca_dma;
377
378 struct ed *ed_rm_list; /* to be removed */
379
380 struct ed *ed_bulktail; /* last in bulk list */
381 struct ed *ed_controltail; /* last in ctrl list */
dd9048af 382 struct ed *periodic [NUM_INTS]; /* shadow int_table */
1da177e4 383
e8b24450 384 void (*start_hnp)(struct ohci_hcd *ohci);
1da177e4
LT		 385
386 /*
387 * memory management for queue data structures
388 */
389 struct dma_pool *td_cache;
390 struct dma_pool *ed_cache;
391 struct td *td_hash [TD_HASH_SIZE];
c6fcb85e 392 struct td *dl_start, *dl_end; /* the done list */
1da177e4 393 struct list_head pending;
81e38333 394 struct list_head eds_in_use; /* all EDs with at least 1 TD */
1da177e4
LT		 395
396 /*
397 * driver state
398 */
b7463c71 399 enum ohci_rh_state rh_state;
fdd13b36 400 int num_ports;
1da177e4 401 int load [NUM_INTS];
dd9048af 402 u32 hc_control; /* copy of hc control reg */
1da177e4
LT		 403 unsigned long next_statechange; /* suspend/resume */
404 u32 fminterval; /* saved register */
8d1a243b 405 unsigned autostop:1; /* rh auto stopping/stopped */
cdb4dd15
AS		 406 unsigned working:1;
407 unsigned restart_work:1;
1da177e4 408
1da177e4
LT		 409 unsigned long flags; /* for HC bugs */
410#define OHCI_QUIRK_AMD756 0x01 /* erratum #4 */
411#define OHCI_QUIRK_SUPERIO 0x02 /* natsemi */
412#define OHCI_QUIRK_INITRESET 0x04 /* SiS, OPTi, ... */
11d1a4aa
BH		 413#define OHCI_QUIRK_BE_DESC 0x08 /* BE descriptors */
414#define OHCI_QUIRK_BE_MMIO 0x10 /* BE registers */
415#define OHCI_QUIRK_ZFMICRO 0x20 /* Compaq ZFMicro chipset*/
d576bb9f 416#define OHCI_QUIRK_NEC 0x40 /* lost interrupts */
4f45426c 417#define OHCI_QUIRK_FRAME_NO 0x80 /* no big endian frame_no shift */
1133cd8a 418#define OHCI_QUIRK_HUB_POWER 0x100 /* distrust firmware power/oc setup */
ad93562b 419#define OHCI_QUIRK_AMD_PLL 0x200 /* AMD PLL quirk*/
a1f17a87 420#define OHCI_QUIRK_AMD_PREFETCH 0x400 /* pre-fetch for ISO transfer */
c1db30a2 421#define OHCI_QUIRK_GLOBAL_SUSPEND 0x800 /* must suspend ports */
21a60f6e 422#define OHCI_QUIRK_QEMU 0x1000 /* relax timing expectations */
c1db30a2 423
1da177e4
LT		 424 // there are also chip quirks/bugs in init logic
425
499b3803 426 unsigned prev_frame_no;
81e38333
AS		 427 unsigned wdh_cnt, prev_wdh_cnt;
428 u32 prev_donehead;
429 struct timer_list io_watchdog;
430
d576bb9f 431 struct work_struct nec_work; /* Worker for NEC quirk */
89a0fd18 432
684c19e0 433 struct dentry *debug_dir;
5c2a1801 434
31fc518b
MG		 435 /* platform-specific data -- must come last */
436 unsigned long priv[0] __aligned(sizeof(s64));
437
1da177e4
LT		 438};
439
2c93e790 440#ifdef CONFIG_USB_PCI
89a0fd18
MN		 441static inline int quirk_nec(struct ohci_hcd *ohci)
442{
443 return ohci->flags & OHCI_QUIRK_NEC;
444}
445static inline int quirk_zfmicro(struct ohci_hcd *ohci)
446{
447 return ohci->flags & OHCI_QUIRK_ZFMICRO;
448}
ab1666c1
LY		 449static inline int quirk_amdiso(struct ohci_hcd *ohci)
450{
ad93562b 451 return ohci->flags & OHCI_QUIRK_AMD_PLL;
ab1666c1 452}
a1f17a87
LY		 453static inline int quirk_amdprefetch(struct ohci_hcd *ohci)
454{
455 return ohci->flags & OHCI_QUIRK_AMD_PREFETCH;
456}
89a0fd18
MN		 457#else
458static inline int quirk_nec(struct ohci_hcd *ohci)
459{
460 return 0;
461}
462static inline int quirk_zfmicro(struct ohci_hcd *ohci)
463{
464 return 0;
465}
ab1666c1
LY		 466static inline int quirk_amdiso(struct ohci_hcd *ohci)
467{
468 return 0;
469}
a1f17a87
LY		 470static inline int quirk_amdprefetch(struct ohci_hcd *ohci)
471{
472 return 0;
473}
89a0fd18
MN		 474#endif
475
1da177e4
LT		 476/* convert between an hcd pointer and the corresponding ohci_hcd */
477static inline struct ohci_hcd *hcd_to_ohci (struct usb_hcd *hcd)
478{
479 return (struct ohci_hcd *) (hcd->hcd_priv);
480}
481static inline struct usb_hcd *ohci_to_hcd (const struct ohci_hcd *ohci)
482{
483 return container_of ((void *) ohci, struct usb_hcd, hcd_priv);
484}
485
486/*-------------------------------------------------------------------------*/
487
1da177e4
LT		 488#define ohci_dbg(ohci, fmt, args...) \
489 dev_dbg (ohci_to_hcd(ohci)->self.controller , fmt , ## args )
490#define ohci_err(ohci, fmt, args...) \
491 dev_err (ohci_to_hcd(ohci)->self.controller , fmt , ## args )
492#define ohci_info(ohci, fmt, args...) \
493 dev_info (ohci_to_hcd(ohci)->self.controller , fmt , ## args )
494#define ohci_warn(ohci, fmt, args...) \
495 dev_warn (ohci_to_hcd(ohci)->self.controller , fmt , ## args )
496
1da177e4
LT		 497/*-------------------------------------------------------------------------*/
498
499/*
500 * While most USB host controllers implement their registers and
501 * in-memory communication descriptors in little-endian format,
502 * a minority (notably the IBM STB04XXX and the Motorola MPC5200
503 * processors) implement them in big endian format.
504 *
11d1a4aa
BH		 505 * In addition some more exotic implementations like the Toshiba
506 * Spider (aka SCC) cell southbridge are "mixed" endian, that is,
507 * they have a different endianness for registers vs. in-memory
508 * descriptors.
509 *
1da177e4
LT		 510 * This attempts to support either format at compile time without a
511 * runtime penalty, or both formats with the additional overhead
512 * of checking a flag bit.
11d1a4aa
BH		 513 *
514 * That leads to some tricky Kconfig rules howevber. There are
515 * different defaults based on some arch/ppc platforms, though
516 * the basic rules are:
517 *
518 * Controller type Kconfig options needed
519 * --------------- ----------------------
520 * little endian CONFIG_USB_OHCI_LITTLE_ENDIAN
521 *
522 * fully big endian CONFIG_USB_OHCI_BIG_ENDIAN_DESC _and_
523 * CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
524 *
525 * mixed endian CONFIG_USB_OHCI_LITTLE_ENDIAN _and_
526 * CONFIG_USB_OHCI_BIG_ENDIAN_{MMIO,DESC}
527 *
528 * (If you have a mixed endian controller, you -must- also define
529 * CONFIG_USB_OHCI_LITTLE_ENDIAN or things will not work when building
530 * both your mixed endian and a fully big endian controller support in
531 * the same kernel image).
1da177e4
LT		 532 */
533
11d1a4aa
BH		 534#ifdef CONFIG_USB_OHCI_BIG_ENDIAN_DESC
535#ifdef CONFIG_USB_OHCI_LITTLE_ENDIAN
536#define big_endian_desc(ohci) (ohci->flags & OHCI_QUIRK_BE_DESC)
537#else
538#define big_endian_desc(ohci) 1 /* only big endian */
539#endif
540#else
541#define big_endian_desc(ohci) 0 /* only little endian */
542#endif
1da177e4 543
11d1a4aa 544#ifdef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
1da177e4 545#ifdef CONFIG_USB_OHCI_LITTLE_ENDIAN
11d1a4aa
BH		 546#define big_endian_mmio(ohci) (ohci->flags & OHCI_QUIRK_BE_MMIO)
547#else
548#define big_endian_mmio(ohci) 1 /* only big endian */
549#endif
1da177e4 550#else
11d1a4aa 551#define big_endian_mmio(ohci) 0 /* only little endian */
1da177e4
LT		 552#endif
553
554/*
555 * Big-endian read/write functions are arch-specific.
556 * Other arches can be added if/when they're needed.
11d1a4aa 557 *
1da177e4 558 */
11d1a4aa
BH		 559static inline unsigned int _ohci_readl (const struct ohci_hcd *ohci,
560 __hc32 __iomem * regs)
1da177e4 561{
b32e904d 562#ifdef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
11d1a4aa 563 return big_endian_mmio(ohci) ?
68f50e52
AV		 564 readl_be (regs) :
565 readl (regs);
b32e904d 566#else
68f50e52 567 return readl (regs);
b32e904d 568#endif
1da177e4
LT		 569}
570
11d1a4aa
BH		 571static inline void _ohci_writel (const struct ohci_hcd *ohci,
572 const unsigned int val, __hc32 __iomem *regs)
1da177e4 573{
b32e904d 574#ifdef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
11d1a4aa 575 big_endian_mmio(ohci) ?
68f50e52
AV		 576 writel_be (val, regs) :
577 writel (val, regs);
b32e904d 578#else
68f50e52 579 writel (val, regs);
b32e904d 580#endif
1da177e4
LT		 581}
582
11d1a4aa
BH		 583#define ohci_readl(o,r) _ohci_readl(o,r)
584#define ohci_writel(o,v,r) _ohci_writel(o,v,r)
1da177e4 585
1da177e4
LT		 586
587/*-------------------------------------------------------------------------*/
588
589/* cpu to ohci */
590static inline __hc16 cpu_to_hc16 (const struct ohci_hcd *ohci, const u16 x)
591{
11d1a4aa
BH		 592 return big_endian_desc(ohci) ?
593 (__force __hc16)cpu_to_be16(x) :
594 (__force __hc16)cpu_to_le16(x);
1da177e4
LT		 595}
596
597static inline __hc16 cpu_to_hc16p (const struct ohci_hcd *ohci, const u16 *x)
598{
11d1a4aa
BH		 599 return big_endian_desc(ohci) ?
600 cpu_to_be16p(x) :
601 cpu_to_le16p(x);
1da177e4
LT		 602}
603
604static inline __hc32 cpu_to_hc32 (const struct ohci_hcd *ohci, const u32 x)
605{
11d1a4aa
BH		 606 return big_endian_desc(ohci) ?
607 (__force __hc32)cpu_to_be32(x) :
608 (__force __hc32)cpu_to_le32(x);
1da177e4
LT		 609}
610
611static inline __hc32 cpu_to_hc32p (const struct ohci_hcd *ohci, const u32 *x)
612{
11d1a4aa
BH		 613 return big_endian_desc(ohci) ?
614 cpu_to_be32p(x) :
615 cpu_to_le32p(x);
1da177e4
LT		 616}
617
618/* ohci to cpu */
619static inline u16 hc16_to_cpu (const struct ohci_hcd *ohci, const __hc16 x)
620{
11d1a4aa
BH		 621 return big_endian_desc(ohci) ?
622 be16_to_cpu((__force __be16)x) :
623 le16_to_cpu((__force __le16)x);
1da177e4
LT		 624}
625
626static inline u16 hc16_to_cpup (const struct ohci_hcd *ohci, const __hc16 *x)
627{
11d1a4aa
BH		 628 return big_endian_desc(ohci) ?
629 be16_to_cpup((__force __be16 *)x) :
630 le16_to_cpup((__force __le16 *)x);
1da177e4
LT		 631}
632
633static inline u32 hc32_to_cpu (const struct ohci_hcd *ohci, const __hc32 x)
634{
11d1a4aa
BH		 635 return big_endian_desc(ohci) ?
636 be32_to_cpu((__force __be32)x) :
637 le32_to_cpu((__force __le32)x);
1da177e4
LT		 638}
639
640static inline u32 hc32_to_cpup (const struct ohci_hcd *ohci, const __hc32 *x)
641{
11d1a4aa
BH		 642 return big_endian_desc(ohci) ?
643 be32_to_cpup((__force __be32 *)x) :
644 le32_to_cpup((__force __le32 *)x);
1da177e4
LT		 645}
646
647/*-------------------------------------------------------------------------*/
648
a4760b34
KC		 649/*
650 * The HCCA frame number is 16 bits, but is accessed as 32 bits since not all
651 * hardware handles 16 bit reads. Depending on the SoC implementation, the
652 * frame number can wind up in either bits [31:16] (default) or
653 * [15:0] (OHCI_QUIRK_FRAME_NO) on big endian hosts.
654 *
655 * Somewhat similarly, the 16-bit PSW fields in a transfer descriptor are
656 * reordered on BE.
1da177e4
LT		 657 */
658
1da177e4
LT		 659static inline u16 ohci_frame_no(const struct ohci_hcd *ohci)
660{
661 u32 tmp;
11d1a4aa 662 if (big_endian_desc(ohci)) {
1da177e4 663 tmp = be32_to_cpup((__force __be32 *)&ohci->hcca->frame_no);
a4760b34 664 if (!(ohci->flags & OHCI_QUIRK_FRAME_NO))
4f45426c 665 tmp >>= 16;
1da177e4
LT		 666 } else
667 tmp = le32_to_cpup((__force __le32 *)&ohci->hcca->frame_no);
668
669 return (u16)tmp;
670}
671
672static inline __hc16 *ohci_hwPSWp(const struct ohci_hcd *ohci,
673 const struct td *td, int index)
674{
11d1a4aa 675 return (__hc16 *)(big_endian_desc(ohci) ?
1da177e4
LT		 676 &td->hwPSW[index ^ 1] : &td->hwPSW[index]);
677}
678
679static inline u16 ohci_hwPSW(const struct ohci_hcd *ohci,
680 const struct td *td, int index)
681{
682 return hc16_to_cpup(ohci, ohci_hwPSWp(ohci, td, index));
683}
684
685/*-------------------------------------------------------------------------*/
686
1da177e4 687#define FI 0x2edf /* 12000 bits per frame (-1) */
dd9048af 688#define FSMP(fi) (0x7fff & ((6 * ((fi) - 210)) / 7))
1da177e4
LT		 689#define FIT (1 << 31)
690#define LSTHRESH 0x628 /* lowspeed bit threshold */
691
abc9404b 692static inline void periodic_reinit (struct ohci_hcd *ohci)
1da177e4
LT		 693{
694 u32 fi = ohci->fminterval & 0x03fff;
695 u32 fit = ohci_readl(ohci, &ohci->regs->fminterval) & FIT;
696
697 ohci_writel (ohci, (fit ^ FIT) | ohci->fminterval,
698 &ohci->regs->fminterval);
699 ohci_writel (ohci, ((9 * fi) / 10) & 0x3fff,
700 &ohci->regs->periodicstart);
701}
702
703/* AMD-756 (D2 rev) reports corrupt register contents in some cases.
704 * The erratum (#4) description is incorrect. AMD's workaround waits
705 * till some bits (mostly reserved) are clear; ok for all revs.
706 */
707#define read_roothub(hc, register, mask) ({ \
708 u32 temp = ohci_readl (hc, &hc->regs->roothub.register); \
709 if (temp == -1) \
b7463c71 710 hc->rh_state = OHCI_RH_HALTED; \
1da177e4
LT		 711 else if (hc->flags & OHCI_QUIRK_AMD756) \
712 while (temp & mask) \
713 temp = ohci_readl (hc, &hc->regs->roothub.register); \
714 temp; })
715
abc9404b 716static inline u32 roothub_a (struct ohci_hcd *hc)
1da177e4
LT		 717 { return read_roothub (hc, a, 0xfc0fe000); }
718static inline u32 roothub_b (struct ohci_hcd *hc)
719 { return ohci_readl (hc, &hc->regs->roothub.b); }
720static inline u32 roothub_status (struct ohci_hcd *hc)
721 { return ohci_readl (hc, &hc->regs->roothub.status); }
abc9404b 722static inline u32 roothub_portstatus (struct ohci_hcd *hc, int i)
1da177e4 723 { return read_roothub (hc, portstatus [i], 0xffe0fce0); }
95e44d44
MG		 724
725/* Declarations of things exported for use by ohci platform drivers */
726
727struct ohci_driver_overrides {
728 const char *product_desc;
729 size_t extra_priv_size;
730 int (*reset)(struct usb_hcd *hcd);
731};
732
733extern void ohci_init_driver(struct hc_driver *drv,
734 const struct ohci_driver_overrides *over);
735extern int ohci_restart(struct ohci_hcd *ohci);
736extern int ohci_setup(struct usb_hcd *hcd);
95e44d44
MG		 737extern int ohci_suspend(struct usb_hcd *hcd, bool do_wakeup);
738extern int ohci_resume(struct usb_hcd *hcd, bool hibernated);
42b59eba
LP		 739extern int ohci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
740 u16 wIndex, char *buf, u16 wLength);
741extern int ohci_hub_status_data(struct usb_hcd *hcd, char *buf);
Linux 6.x block layer and io_uring tree(s)