1 /******************************************************************************
3 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
19 ******************************************************************************/
26 #define MAX_PROT_SZ (64-16)
29 #define _IO_WAIT_COMPLETE 1
30 #define _IO_WAIT_RSP 2
33 #define _IOSZ_MASK_ (0x7F)
34 #define _IO_WRITE_ BIT(7)
35 #define _IO_FIXED_ BIT(8)
36 #define _IO_BURST_ BIT(9)
37 #define _IO_BYTE_ BIT(10)
38 #define _IO_HW_ BIT(11)
39 #define _IO_WORD_ BIT(12)
40 #define _IO_SYNC_ BIT(13)
41 #define _IO_CMDMASK_ (0x1F80)
45 For prompt mode accessing, caller shall free io_req
46 Otherwise, io_handler will free io_req
52 #define _IO_ERR_ BIT(2)
53 #define _IO_SUCCESS_ BIT(1)
54 #define _IO_DONE_ BIT(0)
57 #define IO_RD32 (_IO_SYNC_ | _IO_WORD_)
58 #define IO_RD16 (_IO_SYNC_ | _IO_HW_)
59 #define IO_RD8 (_IO_SYNC_ | _IO_BYTE_)
61 #define IO_RD32_ASYNC (_IO_WORD_)
62 #define IO_RD16_ASYNC (_IO_HW_)
63 #define IO_RD8_ASYNC (_IO_BYTE_)
65 #define IO_WR32 (_IO_WRITE_ | _IO_SYNC_ | _IO_WORD_)
66 #define IO_WR16 (_IO_WRITE_ | _IO_SYNC_ | _IO_HW_)
67 #define IO_WR8 (_IO_WRITE_ | _IO_SYNC_ | _IO_BYTE_)
69 #define IO_WR32_ASYNC (_IO_WRITE_ | _IO_WORD_)
70 #define IO_WR16_ASYNC (_IO_WRITE_ | _IO_HW_)
71 #define IO_WR8_ASYNC (_IO_WRITE_ | _IO_BYTE_)
75 Only Sync. burst accessing is provided.
79 #define IO_WR_BURST(x) (_IO_WRITE_ | _IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_))
80 #define IO_RD_BURST(x) (_IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_))
84 /* below is for the intf_option bit defition... */
86 #define _INTF_ASYNC_ BIT(0) /* support async io */
93 u8(*_read8)(struct intf_hdl *pintfhdl, u32 addr);
94 u16(*_read16)(struct intf_hdl *pintfhdl, u32 addr);
95 u32(*_read32)(struct intf_hdl *pintfhdl, u32 addr);
97 int (*_write8)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
98 int (*_write16)(struct intf_hdl *pintfhdl, u32 addr, __le16 val);
99 int (*_write32)(struct intf_hdl *pintfhdl, u32 addr, __le32 val);
100 int (*_writeN)(struct intf_hdl *pintfhdl, u32 addr, u32 length, u8 *pdata);
102 int (*_write8_async)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
103 int (*_write16_async)(struct intf_hdl *pintfhdl, u32 addr, __le16 val);
104 int (*_write32_async)(struct intf_hdl *pintfhdl, u32 addr, __le32 val);
106 void (*_read_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
107 void (*_write_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
109 void (*_sync_irp_protocol_rw)(struct io_queue *pio_q);
111 u32(*_read_interrupt)(struct intf_hdl *pintfhdl, u32 addr);
113 u32(*_read_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
114 u32(*_write_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
116 u32(*_write_scsi)(struct intf_hdl *pintfhdl, u32 cnt, u8 *pmem);
118 void (*_read_port_cancel)(struct intf_hdl *pintfhdl);
119 void (*_write_port_cancel)(struct intf_hdl *pintfhdl);
121 #ifdef CONFIG_SDIO_HCI
122 u8(*_sd_f0_read8)(struct intf_hdl *pintfhdl, u32 addr);
123 #ifdef CONFIG_SDIO_INDIRECT_ACCESS
124 u8(*_sd_iread8)(struct intf_hdl *pintfhdl, u32 addr);
125 u16(*_sd_iread16)(struct intf_hdl *pintfhdl, u32 addr);
126 u32(*_sd_iread32)(struct intf_hdl *pintfhdl, u32 addr);
127 int (*_sd_iwrite8)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
128 int (*_sd_iwrite16)(struct intf_hdl *pintfhdl, u32 addr, u16 val);
129 int (*_sd_iwrite32)(struct intf_hdl *pintfhdl, u32 addr, u32 val);
130 #endif /* CONFIG_SDIO_INDIRECT_ACCESS */
144 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt);
150 struct dvobj_priv *pintf_dev;/* pointer to &(padapter->dvobjpriv); */
152 struct _io_ops io_ops;
155 struct reg_protocol_rd {
157 #ifdef __LITTLE_ENDIAN
165 u32 WriteEnable:1; /* 0:read, 1:write */
166 u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */
197 u32 FixOrContinuous:1;
212 struct reg_protocol_wt {
215 #ifdef __LITTLE_ENDIAN
223 u32 WriteEnable:1; /* 0:read, 1:write */
224 u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */
253 u32 FixOrContinuous:1;
266 #ifdef CONFIG_PCI_HCI
267 #define MAX_CONTINUAL_IO_ERR 4
270 #ifdef CONFIG_USB_HCI
271 #define MAX_CONTINUAL_IO_ERR 4
274 #ifdef CONFIG_SDIO_HCI
275 #define SD_IO_TRY_CNT (8)
276 #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT
279 #ifdef CONFIG_GSPI_HCI
280 #define SD_IO_TRY_CNT (8)
281 #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT
285 int rtw_inc_and_chk_continual_io_error(struct dvobj_priv *dvobj);
286 void rtw_reset_continual_io_error(struct dvobj_priv *dvobj);
289 Below is the data structure used by _io_handler
296 _list pending; /* The io_req list that will be served in the single protocol read/write. */
298 u8 *free_ioreqs_buf; /* 4-byte aligned */
299 u8 *pallocated_free_ioreqs_buf;
300 struct intf_hdl intf;
307 struct intf_hdl intf;
311 extern uint ioreq_flush(_adapter *adapter, struct io_queue *ioqueue);
312 extern void sync_ioreq_enqueue(struct io_req *preq, struct io_queue *ioqueue);
313 extern uint sync_ioreq_flush(_adapter *adapter, struct io_queue *ioqueue);
316 extern uint free_ioreq(struct io_req *preq, struct io_queue *pio_queue);
317 extern struct io_req *alloc_ioreq(struct io_queue *pio_q);
319 extern uint register_intf_hdl(u8 *dev, struct intf_hdl *pintfhdl);
320 extern void unregister_intf_hdl(struct intf_hdl *pintfhdl);
322 extern void _rtw_attrib_read(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
323 extern void _rtw_attrib_write(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
325 extern u8 _rtw_read8(_adapter *adapter, u32 addr);
326 extern u16 _rtw_read16(_adapter *adapter, u32 addr);
327 extern u32 _rtw_read32(_adapter *adapter, u32 addr);
328 extern void _rtw_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
329 extern void _rtw_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
330 extern void _rtw_read_port_cancel(_adapter *adapter);
333 extern int _rtw_write8(_adapter *adapter, u32 addr, u8 val);
334 extern int _rtw_write16(_adapter *adapter, u32 addr, u16 val);
335 extern int _rtw_write32(_adapter *adapter, u32 addr, u32 val);
336 extern int _rtw_writeN(_adapter *adapter, u32 addr, u32 length, u8 *pdata);
338 #ifdef CONFIG_SDIO_HCI
339 u8 _rtw_sd_f0_read8(_adapter *adapter, u32 addr);
340 #ifdef CONFIG_SDIO_INDIRECT_ACCESS
341 u8 _rtw_sd_iread8(_adapter *adapter, u32 addr);
342 u16 _rtw_sd_iread16(_adapter *adapter, u32 addr);
343 u32 _rtw_sd_iread32(_adapter *adapter, u32 addr);
344 int _rtw_sd_iwrite8(_adapter *adapter, u32 addr, u8 val);
345 int _rtw_sd_iwrite16(_adapter *adapter, u32 addr, u16 val);
346 int _rtw_sd_iwrite32(_adapter *adapter, u32 addr, u32 val);
347 #endif /* CONFIG_SDIO_INDIRECT_ACCESS */
348 #endif /* CONFIG_SDIO_HCI */
350 extern int _rtw_write8_async(_adapter *adapter, u32 addr, u8 val);
351 extern int _rtw_write16_async(_adapter *adapter, u32 addr, u16 val);
352 extern int _rtw_write32_async(_adapter *adapter, u32 addr, u32 val);
354 extern void _rtw_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
355 extern u32 _rtw_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
356 u32 _rtw_write_port_and_wait(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem, int timeout_ms);
357 extern void _rtw_write_port_cancel(_adapter *adapter);
360 bool match_read_sniff_ranges(u32 addr, u16 len);
361 bool match_write_sniff_ranges(u32 addr, u16 len);
362 bool match_rf_read_sniff_ranges(u8 path, u32 addr, u32 mask);
363 bool match_rf_write_sniff_ranges(u8 path, u32 addr, u32 mask);
365 extern u8 dbg_rtw_read8(_adapter *adapter, u32 addr, const char *caller, const int line);
366 extern u16 dbg_rtw_read16(_adapter *adapter, u32 addr, const char *caller, const int line);
367 extern u32 dbg_rtw_read32(_adapter *adapter, u32 addr, const char *caller, const int line);
369 extern int dbg_rtw_write8(_adapter *adapter, u32 addr, u8 val, const char *caller, const int line);
370 extern int dbg_rtw_write16(_adapter *adapter, u32 addr, u16 val, const char *caller, const int line);
371 extern int dbg_rtw_write32(_adapter *adapter, u32 addr, u32 val, const char *caller, const int line);
372 extern int dbg_rtw_writeN(_adapter *adapter, u32 addr , u32 length , u8 *data, const char *caller, const int line);
374 #ifdef CONFIG_SDIO_HCI
375 u8 dbg_rtw_sd_f0_read8(_adapter *adapter, u32 addr, const char *caller, const int line);
376 #ifdef CONFIG_SDIO_INDIRECT_ACCESS
377 u8 dbg_rtw_sd_iread8(_adapter *adapter, u32 addr, const char *caller, const int line);
378 u16 dbg_rtw_sd_iread16(_adapter *adapter, u32 addr, const char *caller, const int line);
379 u32 dbg_rtw_sd_iread32(_adapter *adapter, u32 addr, const char *caller, const int line);
380 int dbg_rtw_sd_iwrite8(_adapter *adapter, u32 addr, u8 val, const char *caller, const int line);
381 int dbg_rtw_sd_iwrite16(_adapter *adapter, u32 addr, u16 val, const char *caller, const int line);
382 int dbg_rtw_sd_iwrite32(_adapter *adapter, u32 addr, u32 val, const char *caller, const int line);
383 #endif /* CONFIG_SDIO_INDIRECT_ACCESS */
384 #endif /* CONFIG_SDIO_HCI */
386 #define rtw_read8(adapter, addr) dbg_rtw_read8((adapter), (addr), __FUNCTION__, __LINE__)
387 #define rtw_read16(adapter, addr) dbg_rtw_read16((adapter), (addr), __FUNCTION__, __LINE__)
388 #define rtw_read32(adapter, addr) dbg_rtw_read32((adapter), (addr), __FUNCTION__, __LINE__)
389 #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem))
390 #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem))
391 #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter))
393 #define rtw_write8(adapter, addr, val) dbg_rtw_write8((adapter), (addr), (val), __FUNCTION__, __LINE__)
394 #define rtw_write16(adapter, addr, val) dbg_rtw_write16((adapter), (addr), (val), __FUNCTION__, __LINE__)
395 #define rtw_write32(adapter, addr, val) dbg_rtw_write32((adapter), (addr), (val), __FUNCTION__, __LINE__)
396 #define rtw_writeN(adapter, addr, length, data) dbg_rtw_writeN((adapter), (addr), (length), (data), __FUNCTION__, __LINE__)
398 #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val))
399 #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val))
400 #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val))
402 #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), addr, cnt, mem)
403 #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port(adapter, addr, cnt, mem)
404 #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms))
405 #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel(adapter)
407 #ifdef CONFIG_SDIO_HCI
408 #define rtw_sd_f0_read8(adapter, addr) dbg_rtw_sd_f0_read8((adapter), (addr), __func__, __LINE__)
409 #ifdef CONFIG_SDIO_INDIRECT_ACCESS
410 #define rtw_sd_iread8(adapter, addr) dbg_rtw_sd_iread8((adapter), (addr), __func__, __LINE__)
411 #define rtw_sd_iread16(adapter, addr) dbg_rtw_sd_iread16((adapter), (addr), __func__, __LINE__)
412 #define rtw_sd_iread32(adapter, addr) dbg_rtw_sd_iread32((adapter), (addr), __func__, __LINE__)
413 #define rtw_sd_iwrite8(adapter, addr, val) dbg_rtw_sd_iwrite8((adapter), (addr), (val), __func__, __LINE__)
414 #define rtw_sd_iwrite16(adapter, addr, val) dbg_rtw_sd_iwrite16((adapter), (addr), (val), __func__, __LINE__)
415 #define rtw_sd_iwrite32(adapter, addr, val) dbg_rtw_sd_iwrite32((adapter), (addr), (val), __func__, __LINE__)
416 #endif /* CONFIG_SDIO_INDIRECT_ACCESS */
417 #endif /* CONFIG_SDIO_HCI */
420 #define match_read_sniff_ranges(addr, len) _FALSE
421 #define match_write_sniff_ranges(addr, len) _FALSE
422 #define match_rf_read_sniff_ranges(path, addr, mask) _FALSE
423 #define match_rf_write_sniff_ranges(path, addr, mask) _FALSE
424 #define rtw_read8(adapter, addr) _rtw_read8((adapter), (addr))
425 #define rtw_read16(adapter, addr) _rtw_read16((adapter), (addr))
426 #define rtw_read32(adapter, addr) _rtw_read32((adapter), (addr))
427 #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem))
428 #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem))
429 #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter))
431 #define rtw_write8(adapter, addr, val) _rtw_write8((adapter), (addr), (val))
432 #define rtw_write16(adapter, addr, val) _rtw_write16((adapter), (addr), (val))
433 #define rtw_write32(adapter, addr, val) _rtw_write32((adapter), (addr), (val))
434 #define rtw_writeN(adapter, addr, length, data) _rtw_writeN((adapter), (addr), (length), (data))
436 #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val))
437 #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val))
438 #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val))
440 #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), (addr), (cnt), (mem))
441 #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port((adapter), (addr), (cnt), (mem))
442 #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms))
443 #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel((adapter))
445 #ifdef CONFIG_SDIO_HCI
446 #define rtw_sd_f0_read8(adapter, addr) _rtw_sd_f0_read8((adapter), (addr))
447 #ifdef CONFIG_SDIO_INDIRECT_ACCESS
448 #define rtw_sd_iread8(adapter, addr) _rtw_sd_iread8((adapter), (addr))
449 #define rtw_sd_iread16(adapter, addr) _rtw_sd_iread16((adapter), (addr))
450 #define rtw_sd_iread32(adapter, addr) _rtw_sd_iread32((adapter), (addr))
451 #define rtw_sd_iwrite8(adapter, addr, val) _rtw_sd_iwrite8((adapter), (addr), (val))
452 #define rtw_sd_iwrite16(adapter, addr, val) _rtw_sd_iwrite16((adapter), (addr), (val))
453 #define rtw_sd_iwrite32(adapter, addr, val) _rtw_sd_iwrite32((adapter), (addr), (val))
454 #endif /* CONFIG_SDIO_INDIRECT_ACCESS */
455 #endif /* CONFIG_SDIO_HCI */
459 extern void rtw_write_scsi(_adapter *adapter, u32 cnt, u8 *pmem);
462 extern void ioreq_read8(_adapter *adapter, u32 addr, u8 *pval);
463 extern void ioreq_read16(_adapter *adapter, u32 addr, u16 *pval);
464 extern void ioreq_read32(_adapter *adapter, u32 addr, u32 *pval);
465 extern void ioreq_write8(_adapter *adapter, u32 addr, u8 val);
466 extern void ioreq_write16(_adapter *adapter, u32 addr, u16 val);
467 extern void ioreq_write32(_adapter *adapter, u32 addr, u32 val);
470 extern uint async_read8(_adapter *adapter, u32 addr, u8 *pbuff,
471 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
472 extern uint async_read16(_adapter *adapter, u32 addr, u8 *pbuff,
473 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
474 extern uint async_read32(_adapter *adapter, u32 addr, u8 *pbuff,
475 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
477 extern void async_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
478 extern void async_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
480 extern void async_write8(_adapter *adapter, u32 addr, u8 val,
481 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
482 extern void async_write16(_adapter *adapter, u32 addr, u16 val,
483 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
484 extern void async_write32(_adapter *adapter, u32 addr, u32 val,
485 void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
487 extern void async_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
488 extern void async_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
491 int rtw_init_io_priv(_adapter *padapter, void (*set_intf_ops)(_adapter *padapter, struct _io_ops *pops));
494 extern uint alloc_io_queue(_adapter *adapter);
495 extern void free_io_queue(_adapter *adapter);
496 extern void async_bus_io(struct io_queue *pio_q);
497 extern void bus_sync_io(struct io_queue *pio_q);
498 extern u32 _ioreq2rwmem(struct io_queue *pio_q);
499 extern void dev_power_down(_adapter *Adapter, u8 bpwrup);
502 #define RTL_R8(reg) rtw_read8(padapter, reg)
503 #define RTL_R16(reg) rtw_read16(padapter, reg)
504 #define RTL_R32(reg) rtw_read32(padapter, reg)
505 #define RTL_W8(reg, val8) rtw_write8(padapter, reg, val8)
506 #define RTL_W16(reg, val16) rtw_write16(padapter, reg, val16)
507 #define RTL_W32(reg, val32) rtw_write32(padapter, reg, val32)
511 #define RTL_W8_ASYNC(reg, val8) rtw_write32_async(padapter, reg, val8)
512 #define RTL_W16_ASYNC(reg, val16) rtw_write32_async(padapter, reg, val16)
513 #define RTL_W32_ASYNC(reg, val32) rtw_write32_async(padapter, reg, val32)
515 #define RTL_WRITE_BB(reg, val32) phy_SetUsbBBReg(padapter, reg, val32)
516 #define RTL_READ_BB(reg) phy_QueryUsbBBReg(padapter, reg)
519 #define PlatformEFIOWrite1Byte(_a, _b, _c) \
520 rtw_write8(_a, _b, _c)
521 #define PlatformEFIOWrite2Byte(_a, _b, _c) \
522 rtw_write16(_a, _b, _c)
523 #define PlatformEFIOWrite4Byte(_a, _b, _c) \
524 rtw_write32(_a, _b, _c)
526 #define PlatformEFIORead1Byte(_a, _b) \
528 #define PlatformEFIORead2Byte(_a, _b) \
530 #define PlatformEFIORead4Byte(_a, _b) \
533 #endif /* _RTL8711_IO_H_ */