1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
6 ******************************************************************************/
13 #define MAX_PROT_SZ (64-16)
16 #define _IO_WAIT_COMPLETE 1
17 #define _IO_WAIT_RSP 2
20 #define _IOSZ_MASK_ (0x7F)
21 #define _IO_WRITE_ BIT(7)
22 #define _IO_FIXED_ BIT(8)
23 #define _IO_BURST_ BIT(9)
24 #define _IO_BYTE_ BIT(10)
25 #define _IO_HW_ BIT(11)
26 #define _IO_WORD_ BIT(12)
27 #define _IO_SYNC_ BIT(13)
28 #define _IO_CMDMASK_ (0x1F80)
32 For prompt mode accessing, caller shall free io_req
33 Otherwise, io_handler will free io_req
39 #define _IO_ERR_ BIT(2)
40 #define _IO_SUCCESS_ BIT(1)
41 #define _IO_DONE_ BIT(0)
44 #define IO_RD32 (_IO_SYNC_ | _IO_WORD_)
45 #define IO_RD16 (_IO_SYNC_ | _IO_HW_)
46 #define IO_RD8 (_IO_SYNC_ | _IO_BYTE_)
48 #define IO_RD32_ASYNC (_IO_WORD_)
49 #define IO_RD16_ASYNC (_IO_HW_)
50 #define IO_RD8_ASYNC (_IO_BYTE_)
52 #define IO_WR32 (_IO_WRITE_ | _IO_SYNC_ | _IO_WORD_)
53 #define IO_WR16 (_IO_WRITE_ | _IO_SYNC_ | _IO_HW_)
54 #define IO_WR8 (_IO_WRITE_ | _IO_SYNC_ | _IO_BYTE_)
56 #define IO_WR32_ASYNC (_IO_WRITE_ | _IO_WORD_)
57 #define IO_WR16_ASYNC (_IO_WRITE_ | _IO_HW_)
58 #define IO_WR8_ASYNC (_IO_WRITE_ | _IO_BYTE_)
62 Only Sync. burst accessing is provided.
66 #define IO_WR_BURST(x) (_IO_WRITE_ | _IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_))
67 #define IO_RD_BURST(x) (_IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_))
71 /* below is for the intf_option bit defition... */
73 #define _INTF_ASYNC_ BIT(0) /* support async io */
80 u8 (*_read8)(struct intf_hdl *pintfhdl, u32 addr);
81 u16 (*_read16)(struct intf_hdl *pintfhdl, u32 addr);
82 u32 (*_read32)(struct intf_hdl *pintfhdl, u32 addr);
84 int (*_write8)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
85 int (*_write16)(struct intf_hdl *pintfhdl, u32 addr, u16 val);
86 int (*_write32)(struct intf_hdl *pintfhdl, u32 addr, u32 val);
87 int (*_writeN)(struct intf_hdl *pintfhdl, u32 addr, u32 length, u8 *pdata);
89 int (*_write8_async)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
90 int (*_write16_async)(struct intf_hdl *pintfhdl, u32 addr, u16 val);
91 int (*_write32_async)(struct intf_hdl *pintfhdl, u32 addr, u32 val);
93 void (*_read_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
94 void (*_write_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
96 void (*_sync_irp_protocol_rw)(struct io_queue *pio_q);
98 u32 (*_read_interrupt)(struct intf_hdl *pintfhdl, u32 addr);
100 u32 (*_read_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
101 u32 (*_write_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
103 u32 (*_write_scsi)(struct intf_hdl *pintfhdl, u32 cnt, u8 *pmem);
105 void (*_read_port_cancel)(struct intf_hdl *pintfhdl);
106 void (*_write_port_cancel)(struct intf_hdl *pintfhdl);
108 u8 (*_sd_f0_read8)(struct intf_hdl *pintfhdl, u32 addr);
112 struct list_head list;
119 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt);
124 struct adapter *padapter;
125 struct dvobj_priv *pintf_dev;/* pointer to &(padapter->dvobjpriv); */
127 struct _io_ops io_ops;
130 struct reg_protocol_rd {
132 #ifdef __LITTLE_ENDIAN
140 u32 WriteEnable:1; /* 0:read, 1:write */
141 u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */
172 u32 FixOrContinuous : 1;
187 struct reg_protocol_wt {
190 #ifdef __LITTLE_ENDIAN
198 u32 WriteEnable:1; /* 0:read, 1:write */
199 u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */
228 u32 FixOrContinuous : 1;
241 #define SD_IO_TRY_CNT (8)
242 #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT
244 int rtw_inc_and_chk_continual_io_error(struct dvobj_priv *dvobj);
245 void rtw_reset_continual_io_error(struct dvobj_priv *dvobj);
248 Below is the data structure used by _io_handler
254 struct list_head free_ioreqs;
255 struct list_head pending; /* The io_req list that will be served in the single protocol read/write. */
256 struct list_head processing;
257 u8 *free_ioreqs_buf; /* 4-byte aligned */
258 u8 *pallocated_free_ioreqs_buf;
259 struct intf_hdl intf;
264 struct adapter *padapter;
266 struct intf_hdl intf;
270 extern uint ioreq_flush(struct adapter *adapter, struct io_queue *ioqueue);
271 extern void sync_ioreq_enqueue(struct io_req *preq, struct io_queue *ioqueue);
272 extern uint sync_ioreq_flush(struct adapter *adapter, struct io_queue *ioqueue);
275 extern uint free_ioreq(struct io_req *preq, struct io_queue *pio_queue);
276 extern struct io_req *alloc_ioreq(struct io_queue *pio_q);
278 extern uint register_intf_hdl(u8 *dev, struct intf_hdl *pintfhdl);
279 extern void unregister_intf_hdl(struct intf_hdl *pintfhdl);
281 extern void _rtw_attrib_read(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
282 extern void _rtw_attrib_write(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
284 extern u8 _rtw_read8(struct adapter *adapter, u32 addr);
285 extern u16 _rtw_read16(struct adapter *adapter, u32 addr);
286 extern u32 _rtw_read32(struct adapter *adapter, u32 addr);
288 extern int _rtw_write8(struct adapter *adapter, u32 addr, u8 val);
289 extern int _rtw_write16(struct adapter *adapter, u32 addr, u16 val);
290 extern int _rtw_write32(struct adapter *adapter, u32 addr, u32 val);
292 extern u8 _rtw_sd_f0_read8(struct adapter *adapter, u32 addr);
294 extern u32 _rtw_write_port(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
296 #define rtw_read8(adapter, addr) _rtw_read8((adapter), (addr))
297 #define rtw_read16(adapter, addr) _rtw_read16((adapter), (addr))
298 #define rtw_read32(adapter, addr) _rtw_read32((adapter), (addr))
300 #define rtw_write8(adapter, addr, val) _rtw_write8((adapter), (addr), (val))
301 #define rtw_write16(adapter, addr, val) _rtw_write16((adapter), (addr), (val))
302 #define rtw_write32(adapter, addr, val) _rtw_write32((adapter), (addr), (val))
304 #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port((adapter), (addr), (cnt), (mem))
306 #define rtw_sd_f0_read8(adapter, addr) _rtw_sd_f0_read8((adapter), (addr))
308 extern void rtw_write_scsi(struct adapter *adapter, u32 cnt, u8 *pmem);
311 extern void ioreq_read8(struct adapter *adapter, u32 addr, u8 *pval);
312 extern void ioreq_read16(struct adapter *adapter, u32 addr, u16 *pval);
313 extern void ioreq_read32(struct adapter *adapter, u32 addr, u32 *pval);
314 extern void ioreq_write8(struct adapter *adapter, u32 addr, u8 val);
315 extern void ioreq_write16(struct adapter *adapter, u32 addr, u16 val);
316 extern void ioreq_write32(struct adapter *adapter, u32 addr, u32 val);
319 extern uint async_read8(struct adapter *adapter, u32 addr, u8 *pbuff,
320 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
321 extern uint async_read16(struct adapter *adapter, u32 addr, u8 *pbuff,
322 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
323 extern uint async_read32(struct adapter *adapter, u32 addr, u8 *pbuff,
324 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
326 extern void async_read_mem(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
327 extern void async_read_port(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
329 extern void async_write8(struct adapter *adapter, u32 addr, u8 val,
330 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
331 extern void async_write16(struct adapter *adapter, u32 addr, u16 val,
332 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
333 extern void async_write32(struct adapter *adapter, u32 addr, u32 val,
334 void (*_async_io_callback)(struct adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
336 extern void async_write_mem(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
337 extern void async_write_port(struct adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
340 int rtw_init_io_priv(struct adapter *padapter, void (*set_intf_ops)(struct adapter *padapter, struct _io_ops *pops));
343 extern uint alloc_io_queue(struct adapter *adapter);
344 extern void free_io_queue(struct adapter *adapter);
345 extern void async_bus_io(struct io_queue *pio_q);
346 extern void bus_sync_io(struct io_queue *pio_q);
347 extern u32 _ioreq2rwmem(struct io_queue *pio_q);
348 extern void dev_power_down(struct adapter * Adapter, u8 bpwrup);
350 #define PlatformEFIOWrite1Byte(_a, _b, _c) \
351 rtw_write8(_a, _b, _c)
352 #define PlatformEFIOWrite2Byte(_a, _b, _c) \
353 rtw_write16(_a, _b, _c)
354 #define PlatformEFIOWrite4Byte(_a, _b, _c) \
355 rtw_write32(_a, _b, _c)
357 #define PlatformEFIORead1Byte(_a, _b) \
359 #define PlatformEFIORead2Byte(_a, _b) \
361 #define PlatformEFIORead4Byte(_a, _b) \
364 #endif /* _RTL8711_IO_H_ */