/****************************************************************************** * * Copyright(c) 2007 - 2017 Realtek Corporation. * * This program is free software; you can redistribute it and/or modify it * under the terms of version 2 of the GNU General Public License as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * *****************************************************************************/ #ifndef _RTW_IO_H_ #define _RTW_IO_H_ #define NUM_IOREQ 8 #ifdef PLATFORM_LINUX #define MAX_PROT_SZ (64-16) #endif #define _IOREADY 0 #define _IO_WAIT_COMPLETE 1 #define _IO_WAIT_RSP 2 /* IO COMMAND TYPE */ #define _IOSZ_MASK_ (0x7F) #define _IO_WRITE_ BIT(7) #define _IO_FIXED_ BIT(8) #define _IO_BURST_ BIT(9) #define _IO_BYTE_ BIT(10) #define _IO_HW_ BIT(11) #define _IO_WORD_ BIT(12) #define _IO_SYNC_ BIT(13) #define _IO_CMDMASK_ (0x1F80) /* For prompt mode accessing, caller shall free io_req Otherwise, io_handler will free io_req */ /* IO STATUS TYPE */ #define _IO_ERR_ BIT(2) #define _IO_SUCCESS_ BIT(1) #define _IO_DONE_ BIT(0) #define IO_RD32 (_IO_SYNC_ | _IO_WORD_) #define IO_RD16 (_IO_SYNC_ | _IO_HW_) #define IO_RD8 (_IO_SYNC_ | _IO_BYTE_) #define IO_RD32_ASYNC (_IO_WORD_) #define IO_RD16_ASYNC (_IO_HW_) #define IO_RD8_ASYNC (_IO_BYTE_) #define IO_WR32 (_IO_WRITE_ | _IO_SYNC_ | _IO_WORD_) #define IO_WR16 (_IO_WRITE_ | _IO_SYNC_ | _IO_HW_) #define IO_WR8 (_IO_WRITE_ | _IO_SYNC_ | _IO_BYTE_) #define IO_WR32_ASYNC (_IO_WRITE_ | _IO_WORD_) #define IO_WR16_ASYNC (_IO_WRITE_ | _IO_HW_) #define IO_WR8_ASYNC (_IO_WRITE_ | _IO_BYTE_) /* Only Sync. burst accessing is provided. */ #define IO_WR_BURST(x) (_IO_WRITE_ | _IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_)) #define IO_RD_BURST(x) (_IO_SYNC_ | _IO_BURST_ | ((x) & _IOSZ_MASK_)) /* below is for the intf_option bit defition... */ #define _INTF_ASYNC_ BIT(0) /* support async io */ struct intf_priv; struct intf_hdl; struct io_queue; struct _io_ops { u8(*_read8)(struct intf_hdl *pintfhdl, u32 addr); u16(*_read16)(struct intf_hdl *pintfhdl, u32 addr); u32(*_read32)(struct intf_hdl *pintfhdl, u32 addr); int (*_write8)(struct intf_hdl *pintfhdl, u32 addr, u8 val); int (*_write16)(struct intf_hdl *pintfhdl, u32 addr, u16 val); int (*_write32)(struct intf_hdl *pintfhdl, u32 addr, u32 val); int (*_writeN)(struct intf_hdl *pintfhdl, u32 addr, u32 length, u8 *pdata); int (*_write8_async)(struct intf_hdl *pintfhdl, u32 addr, u8 val); int (*_write16_async)(struct intf_hdl *pintfhdl, u32 addr, u16 val); int (*_write32_async)(struct intf_hdl *pintfhdl, u32 addr, u32 val); void (*_read_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem); void (*_write_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem); u32(*_read_interrupt)(struct intf_hdl *pintfhdl, u32 addr); u32(*_read_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem); u32(*_write_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem); void (*_read_port_cancel)(struct intf_hdl *pintfhdl); void (*_write_port_cancel)(struct intf_hdl *pintfhdl); #ifdef CONFIG_SDIO_HCI u8(*_sd_f0_read8)(struct intf_hdl *pintfhdl, u32 addr); #ifdef CONFIG_SDIO_INDIRECT_ACCESS u8(*_sd_iread8)(struct intf_hdl *pintfhdl, u32 addr); u16(*_sd_iread16)(struct intf_hdl *pintfhdl, u32 addr); u32(*_sd_iread32)(struct intf_hdl *pintfhdl, u32 addr); int (*_sd_iwrite8)(struct intf_hdl *pintfhdl, u32 addr, u8 val); int (*_sd_iwrite16)(struct intf_hdl *pintfhdl, u32 addr, u16 val); int (*_sd_iwrite32)(struct intf_hdl *pintfhdl, u32 addr, u32 val); #endif /* CONFIG_SDIO_INDIRECT_ACCESS */ #endif }; struct io_req { _list list; u32 addr; volatile u32 val; u32 command; u32 status; u8 *pbuf; _sema sema; void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt); u8 *cnxt; }; struct intf_hdl { _adapter *padapter; struct dvobj_priv *pintf_dev;/* pointer to &(padapter->dvobjpriv); */ struct _io_ops io_ops; }; struct reg_protocol_rd { #ifdef CONFIG_LITTLE_ENDIAN /* DW1 */ u32 NumOfTrans:4; u32 Reserved1:4; u32 Reserved2:24; /* DW2 */ u32 ByteCount:7; u32 WriteEnable:1; /* 0:read, 1:write */ u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */ u32 BurstMode:1; u32 Byte1Access:1; u32 Byte2Access:1; u32 Byte4Access:1; u32 Reserved3:3; u32 Reserved4:16; /* DW3 */ u32 BusAddress; /* DW4 */ /* u32 Value; */ #else /* DW1 */ u32 Reserved1:4; u32 NumOfTrans:4; u32 Reserved2:24; /* DW2 */ u32 WriteEnable:1; u32 ByteCount:7; u32 Reserved3:3; u32 Byte4Access:1; u32 Byte2Access:1; u32 Byte1Access:1; u32 BurstMode:1; u32 FixOrContinuous:1; u32 Reserved4:16; /* DW3 */ u32 BusAddress; /* DW4 */ /* u32 Value; */ #endif }; struct reg_protocol_wt { #ifdef CONFIG_LITTLE_ENDIAN /* DW1 */ u32 NumOfTrans:4; u32 Reserved1:4; u32 Reserved2:24; /* DW2 */ u32 ByteCount:7; u32 WriteEnable:1; /* 0:read, 1:write */ u32 FixOrContinuous:1; /* 0:continuous, 1: Fix */ u32 BurstMode:1; u32 Byte1Access:1; u32 Byte2Access:1; u32 Byte4Access:1; u32 Reserved3:3; u32 Reserved4:16; /* DW3 */ u32 BusAddress; /* DW4 */ u32 Value; #else /* DW1 */ u32 Reserved1:4; u32 NumOfTrans:4; u32 Reserved2:24; /* DW2 */ u32 WriteEnable:1; u32 ByteCount:7; u32 Reserved3:3; u32 Byte4Access:1; u32 Byte2Access:1; u32 Byte1Access:1; u32 BurstMode:1; u32 FixOrContinuous:1; u32 Reserved4:16; /* DW3 */ u32 BusAddress; /* DW4 */ u32 Value; #endif }; #ifdef CONFIG_PCI_HCI #define MAX_CONTINUAL_IO_ERR 4 #endif #ifdef CONFIG_USB_HCI #define MAX_CONTINUAL_IO_ERR 4 #endif #ifdef CONFIG_SDIO_HCI #define SD_IO_TRY_CNT (8) #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT #endif #ifdef CONFIG_GSPI_HCI #define SD_IO_TRY_CNT (8) #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT #endif int rtw_inc_and_chk_continual_io_error(struct dvobj_priv *dvobj); void rtw_reset_continual_io_error(struct dvobj_priv *dvobj); /* Below is the data structure used by _io_handler */ struct io_queue { _lock lock; _list free_ioreqs; _list pending; /* The io_req list that will be served in the single protocol read/write. */ _list processing; u8 *free_ioreqs_buf; /* 4-byte aligned */ u8 *pallocated_free_ioreqs_buf; struct intf_hdl intf; }; struct io_priv { _adapter *padapter; struct intf_hdl intf; }; extern uint ioreq_flush(_adapter *adapter, struct io_queue *ioqueue); extern void sync_ioreq_enqueue(struct io_req *preq, struct io_queue *ioqueue); extern uint sync_ioreq_flush(_adapter *adapter, struct io_queue *ioqueue); extern uint free_ioreq(struct io_req *preq, struct io_queue *pio_queue); extern struct io_req *alloc_ioreq(struct io_queue *pio_q); extern uint register_intf_hdl(u8 *dev, struct intf_hdl *pintfhdl); extern void unregister_intf_hdl(struct intf_hdl *pintfhdl); extern void _rtw_attrib_read(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void _rtw_attrib_write(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern u8 rtw_read8(_adapter *adapter, u32 addr); extern u16 rtw_read16(_adapter *adapter, u32 addr); extern u32 rtw_read32(_adapter *adapter, u32 addr); extern void _rtw_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void _rtw_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void _rtw_read_port_cancel(_adapter *adapter); extern int rtw_write8(_adapter *adapter, u32 addr, u8 val); extern int rtw_write16(_adapter *adapter, u32 addr, u16 val); extern int rtw_write32(_adapter *adapter, u32 addr, u32 val); extern int rtw_writeN(_adapter *adapter, u32 addr, u32 length, u8 *pdata); #ifdef CONFIG_SDIO_HCI u8 _rtw_sd_f0_read8(_adapter *adapter, u32 addr); #ifdef CONFIG_SDIO_INDIRECT_ACCESS u8 _rtw_sd_iread8(_adapter *adapter, u32 addr); u16 _rtw_sd_iread16(_adapter *adapter, u32 addr); u32 _rtw_sd_iread32(_adapter *adapter, u32 addr); int _rtw_sd_iwrite8(_adapter *adapter, u32 addr, u8 val); int _rtw_sd_iwrite16(_adapter *adapter, u32 addr, u16 val); int _rtw_sd_iwrite32(_adapter *adapter, u32 addr, u32 val); #endif /* CONFIG_SDIO_INDIRECT_ACCESS */ #endif /* CONFIG_SDIO_HCI */ extern int _rtw_write8_async(_adapter *adapter, u32 addr, u8 val); extern int _rtw_write16_async(_adapter *adapter, u32 addr, u16 val); extern int _rtw_write32_async(_adapter *adapter, u32 addr, u32 val); extern void _rtw_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern u32 _rtw_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); u32 _rtw_write_port_and_wait(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem, int timeout_ms); extern void _rtw_write_port_cancel(_adapter *adapter); #ifdef DBG_IO struct rtw_io_sniff_ent; const char *rtw_io_sniff_ent_get_tag(const struct rtw_io_sniff_ent *ent); const struct rtw_io_sniff_ent *match_read_sniff(_adapter *adapter, u32 addr, u16 len, u32 val); const struct rtw_io_sniff_ent *match_write_sniff(_adapter *adapter, u32 addr, u16 len, u32 val); bool match_rf_read_sniff_ranges(_adapter *adapter, u8 path, u32 addr, u32 mask); bool match_rf_write_sniff_ranges(_adapter *adapter, u8 path, u32 addr, u32 mask); #ifdef CONFIG_SDIO_HCI u8 dbg_rtw_sd_f0_read8(_adapter *adapter, u32 addr, const char *caller, const int line); #ifdef CONFIG_SDIO_INDIRECT_ACCESS u8 dbg_rtw_sd_iread8(_adapter *adapter, u32 addr, const char *caller, const int line); u16 dbg_rtw_sd_iread16(_adapter *adapter, u32 addr, const char *caller, const int line); u32 dbg_rtw_sd_iread32(_adapter *adapter, u32 addr, const char *caller, const int line); int dbg_rtw_sd_iwrite8(_adapter *adapter, u32 addr, u8 val, const char *caller, const int line); int dbg_rtw_sd_iwrite16(_adapter *adapter, u32 addr, u16 val, const char *caller, const int line); int dbg_rtw_sd_iwrite32(_adapter *adapter, u32 addr, u32 val, const char *caller, const int line); #endif /* CONFIG_SDIO_INDIRECT_ACCESS */ #endif /* CONFIG_SDIO_HCI */ #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem)) #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem)) #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter)) #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val)) #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val)) #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val)) #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), addr, cnt, mem) #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port(adapter, addr, cnt, mem) #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms)) #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel(adapter) #ifdef CONFIG_SDIO_HCI #define rtw_sd_f0_read8(adapter, addr) dbg_rtw_sd_f0_read8((adapter), (addr), __func__, __LINE__) #ifdef CONFIG_SDIO_INDIRECT_ACCESS #define rtw_sd_iread8(adapter, addr) dbg_rtw_sd_iread8((adapter), (addr), __func__, __LINE__) #define rtw_sd_iread16(adapter, addr) dbg_rtw_sd_iread16((adapter), (addr), __func__, __LINE__) #define rtw_sd_iread32(adapter, addr) dbg_rtw_sd_iread32((adapter), (addr), __func__, __LINE__) #define rtw_sd_iwrite8(adapter, addr, val) dbg_rtw_sd_iwrite8((adapter), (addr), (val), __func__, __LINE__) #define rtw_sd_iwrite16(adapter, addr, val) dbg_rtw_sd_iwrite16((adapter), (addr), (val), __func__, __LINE__) #define rtw_sd_iwrite32(adapter, addr, val) dbg_rtw_sd_iwrite32((adapter), (addr), (val), __func__, __LINE__) #endif /* CONFIG_SDIO_INDIRECT_ACCESS */ #endif /* CONFIG_SDIO_HCI */ #else /* DBG_IO */ #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem)) #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem)) #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter)) #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val)) #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val)) #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val)) #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), (addr), (cnt), (mem)) #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port((adapter), (addr), (cnt), (mem)) #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms)) #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel((adapter)) #ifdef CONFIG_SDIO_HCI #define rtw_sd_f0_read8(adapter, addr) _rtw_sd_f0_read8((adapter), (addr)) #ifdef CONFIG_SDIO_INDIRECT_ACCESS #define rtw_sd_iread8(adapter, addr) _rtw_sd_iread8((adapter), (addr)) #define rtw_sd_iread16(adapter, addr) _rtw_sd_iread16((adapter), (addr)) #define rtw_sd_iread32(adapter, addr) _rtw_sd_iread32((adapter), (addr)) #define rtw_sd_iwrite8(adapter, addr, val) _rtw_sd_iwrite8((adapter), (addr), (val)) #define rtw_sd_iwrite16(adapter, addr, val) _rtw_sd_iwrite16((adapter), (addr), (val)) #define rtw_sd_iwrite32(adapter, addr, val) _rtw_sd_iwrite32((adapter), (addr), (val)) #endif /* CONFIG_SDIO_INDIRECT_ACCESS */ #endif /* CONFIG_SDIO_HCI */ #endif /* DBG_IO */ extern void rtw_write_scsi(_adapter *adapter, u32 cnt, u8 *pmem); /* ioreq */ extern void ioreq_read8(_adapter *adapter, u32 addr, u8 *pval); extern void ioreq_read16(_adapter *adapter, u32 addr, u16 *pval); extern void ioreq_read32(_adapter *adapter, u32 addr, u32 *pval); extern void ioreq_write8(_adapter *adapter, u32 addr, u8 val); extern void ioreq_write16(_adapter *adapter, u32 addr, u16 val); extern void ioreq_write32(_adapter *adapter, u32 addr, u32 val); extern uint async_read8(_adapter *adapter, u32 addr, u8 *pbuff, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern uint async_read16(_adapter *adapter, u32 addr, u8 *pbuff, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern uint async_read32(_adapter *adapter, u32 addr, u8 *pbuff, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern void async_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void async_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void async_write8(_adapter *adapter, u32 addr, u8 val, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern void async_write16(_adapter *adapter, u32 addr, u16 val, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern void async_write32(_adapter *adapter, u32 addr, u32 val, void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); extern void async_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); extern void async_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem); int rtw_init_io_priv(_adapter *padapter, void (*set_intf_ops)(_adapter *padapter, struct _io_ops *pops)); extern uint alloc_io_queue(_adapter *adapter); extern void free_io_queue(_adapter *adapter); extern void async_bus_io(struct io_queue *pio_q); extern void bus_sync_io(struct io_queue *pio_q); extern u32 _ioreq2rwmem(struct io_queue *pio_q); extern void dev_power_down(_adapter *Adapter, u8 bpwrup); #endif /* _RTL8711_IO_H_ */