bad0acc5f4d91289aefc0e9efdab0f3910866cde
[firefly-linux-kernel-4.4.55.git] / drivers / net / wireless / rockchip_wlan / rtl8723bs / include / rtw_io.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
4  *                                        
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.
8  *
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
12  * more details.
13  *
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
17  *
18  *
19  ******************************************************************************/
20
21 #ifndef _RTW_IO_H_
22 #define _RTW_IO_H_
23
24 #define NUM_IOREQ               8
25
26 #ifdef PLATFORM_WINDOWS
27 #define MAX_PROT_SZ     64
28 #endif
29 #ifdef PLATFORM_LINUX
30 #define MAX_PROT_SZ     (64-16)
31 #endif
32
33 #define _IOREADY                        0
34 #define _IO_WAIT_COMPLETE   1
35 #define _IO_WAIT_RSP        2
36
37 // IO COMMAND TYPE
38 #define _IOSZ_MASK_             (0x7F)
39 #define _IO_WRITE_              BIT(7)
40 #define _IO_FIXED_              BIT(8)
41 #define _IO_BURST_              BIT(9)
42 #define _IO_BYTE_               BIT(10)
43 #define _IO_HW_                 BIT(11)
44 #define _IO_WORD_               BIT(12)
45 #define _IO_SYNC_               BIT(13)
46 #define _IO_CMDMASK_    (0x1F80)
47
48
49 /* 
50         For prompt mode accessing, caller shall free io_req
51         Otherwise, io_handler will free io_req
52 */
53
54
55
56 // IO STATUS TYPE
57 #define _IO_ERR_                BIT(2)
58 #define _IO_SUCCESS_    BIT(1)
59 #define _IO_DONE_               BIT(0)
60
61
62 #define IO_RD32                 (_IO_SYNC_ | _IO_WORD_)
63 #define IO_RD16                 (_IO_SYNC_ | _IO_HW_)
64 #define IO_RD8                  (_IO_SYNC_ | _IO_BYTE_)
65
66 #define IO_RD32_ASYNC   (_IO_WORD_)
67 #define IO_RD16_ASYNC   (_IO_HW_)
68 #define IO_RD8_ASYNC    (_IO_BYTE_)
69
70 #define IO_WR32                 (_IO_WRITE_ | _IO_SYNC_ | _IO_WORD_)
71 #define IO_WR16                 (_IO_WRITE_ | _IO_SYNC_ | _IO_HW_)
72 #define IO_WR8                  (_IO_WRITE_ | _IO_SYNC_ | _IO_BYTE_)
73
74 #define IO_WR32_ASYNC   (_IO_WRITE_ | _IO_WORD_)
75 #define IO_WR16_ASYNC   (_IO_WRITE_ | _IO_HW_)
76 #define IO_WR8_ASYNC    (_IO_WRITE_ | _IO_BYTE_)
77
78 /*
79
80         Only Sync. burst accessing is provided.
81
82 */
83
84 #define IO_WR_BURST(x)          (_IO_WRITE_ | _IO_SYNC_ | _IO_BURST_ | ( (x) & _IOSZ_MASK_))
85 #define IO_RD_BURST(x)          (_IO_SYNC_ | _IO_BURST_ | ( (x) & _IOSZ_MASK_))
86
87
88
89 //below is for the intf_option bit defition...
90
91 #define _INTF_ASYNC_    BIT(0)  //support async io
92
93 struct intf_priv;
94 struct intf_hdl;
95 struct io_queue;
96
97 struct _io_ops
98 {
99                 u8 (*_read8)(struct intf_hdl *pintfhdl, u32 addr);
100                 u16 (*_read16)(struct intf_hdl *pintfhdl, u32 addr);
101                 u32 (*_read32)(struct intf_hdl *pintfhdl, u32 addr);
102
103                 int (*_write8)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
104                 int (*_write16)(struct intf_hdl *pintfhdl, u32 addr, u16 val);
105                 int (*_write32)(struct intf_hdl *pintfhdl, u32 addr, u32 val);
106                 int (*_writeN)(struct intf_hdl *pintfhdl, u32 addr, u32 length, u8 *pdata);
107
108                 int (*_write8_async)(struct intf_hdl *pintfhdl, u32 addr, u8 val);
109                 int (*_write16_async)(struct intf_hdl *pintfhdl, u32 addr, u16 val);
110                 int (*_write32_async)(struct intf_hdl *pintfhdl, u32 addr, u32 val);
111
112                 void (*_read_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
113                 void (*_write_mem)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
114
115                 void (*_sync_irp_protocol_rw)(struct io_queue *pio_q);
116
117                 u32 (*_read_interrupt)(struct intf_hdl *pintfhdl, u32 addr);
118
119                 u32 (*_read_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
120                 u32 (*_write_port)(struct intf_hdl *pintfhdl, u32 addr, u32 cnt, u8 *pmem);
121
122                 u32 (*_write_scsi)(struct intf_hdl *pintfhdl,u32 cnt, u8 *pmem);
123
124                 void (*_read_port_cancel)(struct intf_hdl *pintfhdl);
125                 void (*_write_port_cancel)(struct intf_hdl *pintfhdl);
126
127 #ifdef CONFIG_SDIO_HCI
128                 u8 (*_sd_f0_read8)(struct intf_hdl *pintfhdl, u32 addr);
129 #endif
130                 
131 };
132
133 struct io_req { 
134         _list   list;
135         u32     addr;   
136         volatile u32    val;
137         u32     command;
138         u32     status;
139         u8      *pbuf;  
140         _sema   sema;
141
142 #ifdef PLATFORM_OS_CE
143 #ifdef CONFIG_USB_HCI
144         // URB handler for rtw_write_mem
145         USB_TRANSFER usb_transfer_write_mem;
146 #endif
147 #endif
148         
149         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt);
150         u8 *cnxt;       
151
152 #ifdef PLATFORM_OS_XP   
153         PMDL pmdl;
154         PIRP  pirp; 
155
156 #ifdef CONFIG_SDIO_HCI
157         PSDBUS_REQUEST_PACKET sdrp;
158 #endif  
159
160 #endif  
161
162
163 };
164
165 struct  intf_hdl {
166
167 /*      
168         u32     intf_option;
169         u32     bus_status;
170         u32     do_flush;
171         u8      *adapter;
172         u8      *intf_dev;      
173         struct intf_priv        *pintfpriv;
174         u8      cnt;
175         void (*intf_hdl_init)(u8 *priv);
176         void (*intf_hdl_unload)(u8 *priv);
177         void (*intf_hdl_open)(u8 *priv);
178         void (*intf_hdl_close)(u8 *priv);
179         struct  _io_ops io_ops;
180         //u8 intf_status;//moved to struct intf_priv
181         u16 len;
182         u16 done_len;   
183 */
184         _adapter *padapter;
185         struct dvobj_priv *pintf_dev;// pointer to &(padapter->dvobjpriv);
186
187         struct _io_ops  io_ops;
188
189 };
190
191 struct reg_protocol_rd {
192
193 #ifdef CONFIG_LITTLE_ENDIAN     
194
195         //DW1
196         u32             NumOfTrans:4;
197         u32             Reserved1:4;
198         u32             Reserved2:24;
199         //DW2
200         u32             ByteCount:7;
201         u32             WriteEnable:1;          //0:read, 1:write
202         u32             FixOrContinuous:1;      //0:continuous, 1: Fix
203         u32             BurstMode:1;
204         u32             Byte1Access:1;
205         u32             Byte2Access:1;
206         u32             Byte4Access:1;
207         u32             Reserved3:3;
208         u32             Reserved4:16;
209         //DW3
210         u32             BusAddress;
211         //DW4
212         //u32           Value;
213 #else
214
215
216 //DW1
217         u32 Reserved1  :4;
218         u32 NumOfTrans :4;      
219
220         u32 Reserved2  :24;     
221
222         //DW2
223         u32 WriteEnable : 1;
224         u32 ByteCount :7;       
225
226
227         u32 Reserved3 : 3;
228         u32 Byte4Access : 1;    
229
230         u32 Byte2Access : 1;
231         u32 Byte1Access : 1;    
232         u32 BurstMode :1 ;      
233         u32 FixOrContinuous : 1;        
234
235         u32 Reserved4 : 16;
236
237         //DW3
238         u32             BusAddress;
239
240         //DW4
241         //u32           Value;
242
243 #endif
244         
245 };
246
247
248 struct reg_protocol_wt {
249         
250
251 #ifdef CONFIG_LITTLE_ENDIAN
252
253         //DW1
254         u32             NumOfTrans:4;
255         u32             Reserved1:4;
256         u32             Reserved2:24;
257         //DW2
258         u32             ByteCount:7;
259         u32             WriteEnable:1;          //0:read, 1:write
260         u32             FixOrContinuous:1;      //0:continuous, 1: Fix
261         u32             BurstMode:1;
262         u32             Byte1Access:1;
263         u32             Byte2Access:1;
264         u32             Byte4Access:1;
265         u32             Reserved3:3;
266         u32             Reserved4:16;
267         //DW3
268         u32             BusAddress;
269         //DW4
270         u32             Value;
271
272 #else
273         //DW1
274         u32 Reserved1  :4;
275         u32 NumOfTrans :4;      
276
277         u32 Reserved2  :24;     
278
279         //DW2
280         u32 WriteEnable : 1;
281         u32 ByteCount :7;       
282                 
283         u32 Reserved3 : 3;
284         u32 Byte4Access : 1;    
285
286         u32 Byte2Access : 1;
287         u32 Byte1Access : 1;    
288         u32 BurstMode :1 ;      
289         u32 FixOrContinuous : 1;        
290
291         u32 Reserved4 : 16;
292
293         //DW3
294         u32             BusAddress;
295
296         //DW4
297         u32             Value;
298
299 #endif
300
301 };
302 #ifdef CONFIG_PCI_HCI
303 #define MAX_CONTINUAL_IO_ERR 4
304 #endif
305
306 #ifdef CONFIG_USB_HCI
307 #define MAX_CONTINUAL_IO_ERR 4
308 #endif
309
310 #ifdef CONFIG_SDIO_HCI
311 #define SD_IO_TRY_CNT (8)
312 #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT
313 #endif
314
315 #ifdef CONFIG_GSPI_HCI
316 #define SD_IO_TRY_CNT (8)
317 #define MAX_CONTINUAL_IO_ERR SD_IO_TRY_CNT
318 #endif
319
320
321 int rtw_inc_and_chk_continual_io_error(struct dvobj_priv *dvobj);
322 void rtw_reset_continual_io_error(struct dvobj_priv *dvobj);
323
324 /*
325 Below is the data structure used by _io_handler
326
327 */
328
329 struct io_queue {       
330         _lock   lock;   
331         _list   free_ioreqs;    
332         _list           pending;                //The io_req list that will be served in the single protocol read/write.        
333         _list           processing;
334         u8      *free_ioreqs_buf; // 4-byte aligned
335         u8      *pallocated_free_ioreqs_buf;
336         struct  intf_hdl        intf;
337 };
338
339 struct io_priv{
340         
341         _adapter *padapter;     
342                 
343         struct intf_hdl intf;
344
345 };
346
347 extern uint ioreq_flush(_adapter *adapter, struct io_queue *ioqueue);
348 extern void sync_ioreq_enqueue(struct io_req *preq,struct io_queue *ioqueue);
349 extern uint sync_ioreq_flush(_adapter *adapter, struct io_queue *ioqueue);
350
351
352 extern uint free_ioreq(struct io_req *preq, struct io_queue *pio_queue);
353 extern struct io_req *alloc_ioreq(struct io_queue *pio_q);
354
355 extern uint register_intf_hdl(u8 *dev, struct intf_hdl *pintfhdl);
356 extern void unregister_intf_hdl(struct intf_hdl *pintfhdl);
357
358 extern void _rtw_attrib_read(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
359 extern void _rtw_attrib_write(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
360
361 extern u8 _rtw_read8(_adapter *adapter, u32 addr);
362 extern u16 _rtw_read16(_adapter *adapter, u32 addr);
363 extern u32 _rtw_read32(_adapter *adapter, u32 addr);
364 extern void _rtw_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
365 extern void _rtw_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
366 extern void _rtw_read_port_cancel(_adapter *adapter);
367
368
369 extern int _rtw_write8(_adapter *adapter, u32 addr, u8 val);
370 extern int _rtw_write16(_adapter *adapter, u32 addr, u16 val);
371 extern int _rtw_write32(_adapter *adapter, u32 addr, u32 val);
372 extern int _rtw_writeN(_adapter *adapter, u32 addr, u32 length, u8 *pdata);
373
374 extern u8 _rtw_sd_f0_read8(_adapter *adapter, u32 addr);
375
376 extern int _rtw_write8_async(_adapter *adapter, u32 addr, u8 val);
377 extern int _rtw_write16_async(_adapter *adapter, u32 addr, u16 val);
378 extern int _rtw_write32_async(_adapter *adapter, u32 addr, u32 val);
379
380 extern void _rtw_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
381 extern u32 _rtw_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
382 u32 _rtw_write_port_and_wait(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem, int timeout_ms);
383 extern void _rtw_write_port_cancel(_adapter *adapter);
384
385 #ifdef DBG_IO
386 bool match_read_sniff_ranges(u16 addr, u16 len);
387 bool match_write_sniff_ranges(u16 addr, u16 len);
388
389 extern u8 dbg_rtw_read8(_adapter *adapter, u32 addr, const char *caller, const int line);
390 extern u16 dbg_rtw_read16(_adapter *adapter, u32 addr, const char *caller, const int line);
391 extern u32 dbg_rtw_read32(_adapter *adapter, u32 addr, const char *caller, const int line);
392
393 extern int dbg_rtw_write8(_adapter *adapter, u32 addr, u8 val, const char *caller, const int line);
394 extern int dbg_rtw_write16(_adapter *adapter, u32 addr, u16 val, const char *caller, const int line);
395 extern int dbg_rtw_write32(_adapter *adapter, u32 addr, u32 val, const char *caller, const int line);
396 extern int dbg_rtw_writeN(_adapter *adapter, u32 addr ,u32 length , u8 *data, const char *caller, const int line);
397
398 #define rtw_read8(adapter, addr) dbg_rtw_read8((adapter), (addr), __FUNCTION__, __LINE__)
399 #define rtw_read16(adapter, addr) dbg_rtw_read16((adapter), (addr), __FUNCTION__, __LINE__)
400 #define rtw_read32(adapter, addr) dbg_rtw_read32((adapter), (addr), __FUNCTION__, __LINE__)
401 #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem))
402 #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem))
403 #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter))
404
405 #define  rtw_write8(adapter, addr, val) dbg_rtw_write8((adapter), (addr), (val), __FUNCTION__, __LINE__)
406 #define  rtw_write16(adapter, addr, val) dbg_rtw_write16((adapter), (addr), (val), __FUNCTION__, __LINE__)
407 #define  rtw_write32(adapter, addr, val) dbg_rtw_write32((adapter), (addr), (val), __FUNCTION__, __LINE__)
408 #define  rtw_writeN(adapter, addr, length, data) dbg_rtw_writeN((adapter), (addr), (length), (data), __FUNCTION__, __LINE__)
409
410 #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val))
411 #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val))
412 #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val))
413
414 #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), addr, cnt, mem)
415 #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port(adapter, addr, cnt, mem)
416 #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms))
417 #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel(adapter)
418 #else //DBG_IO
419 #define rtw_read8(adapter, addr) _rtw_read8((adapter), (addr))
420 #define rtw_read16(adapter, addr) _rtw_read16((adapter), (addr))
421 #define rtw_read32(adapter, addr) _rtw_read32((adapter), (addr))
422 #define rtw_read_mem(adapter, addr, cnt, mem) _rtw_read_mem((adapter), (addr), (cnt), (mem))
423 #define rtw_read_port(adapter, addr, cnt, mem) _rtw_read_port((adapter), (addr), (cnt), (mem))
424 #define rtw_read_port_cancel(adapter) _rtw_read_port_cancel((adapter))
425
426 #define  rtw_write8(adapter, addr, val) _rtw_write8((adapter), (addr), (val))
427 #define  rtw_write16(adapter, addr, val) _rtw_write16((adapter), (addr), (val))
428 #define  rtw_write32(adapter, addr, val) _rtw_write32((adapter), (addr), (val))
429 #define  rtw_writeN(adapter, addr, length, data) _rtw_writeN((adapter), (addr), (length), (data))
430
431 #define rtw_write8_async(adapter, addr, val) _rtw_write8_async((adapter), (addr), (val))
432 #define rtw_write16_async(adapter, addr, val) _rtw_write16_async((adapter), (addr), (val))
433 #define rtw_write32_async(adapter, addr, val) _rtw_write32_async((adapter), (addr), (val))
434
435 #define rtw_write_mem(adapter, addr, cnt, mem) _rtw_write_mem((adapter), (addr), (cnt), (mem))
436 #define rtw_write_port(adapter, addr, cnt, mem) _rtw_write_port((adapter), (addr), (cnt), (mem))
437 #define rtw_write_port_and_wait(adapter, addr, cnt, mem, timeout_ms) _rtw_write_port_and_wait((adapter), (addr), (cnt), (mem), (timeout_ms))
438 #define rtw_write_port_cancel(adapter) _rtw_write_port_cancel((adapter))
439 #endif //DBG_IO
440
441 #define rtw_sd_f0_read8(adapter, addr) _rtw_sd_f0_read8((adapter), (addr))
442
443 extern void rtw_write_scsi(_adapter *adapter, u32 cnt, u8 *pmem);
444
445 //ioreq 
446 extern void ioreq_read8(_adapter *adapter, u32 addr, u8 *pval);
447 extern void ioreq_read16(_adapter *adapter, u32 addr, u16 *pval);       
448 extern void ioreq_read32(_adapter *adapter, u32 addr, u32 *pval);
449 extern void ioreq_write8(_adapter *adapter, u32 addr, u8 val);
450 extern void ioreq_write16(_adapter *adapter, u32 addr, u16 val);
451 extern void ioreq_write32(_adapter *adapter, u32 addr, u32 val);
452
453
454 extern uint async_read8(_adapter *adapter, u32 addr, u8 *pbuff,
455         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); 
456 extern uint async_read16(_adapter *adapter, u32 addr,  u8 *pbuff,
457         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); 
458 extern uint async_read32(_adapter *adapter, u32 addr,  u8 *pbuff,
459         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt); 
460
461 extern void async_read_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
462 extern void async_read_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
463
464 extern void async_write8(_adapter *adapter, u32 addr, u8 val,
465         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
466 extern void async_write16(_adapter *adapter, u32 addr, u16 val,
467         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
468 extern void async_write32(_adapter *adapter, u32 addr, u32 val,
469         void (*_async_io_callback)(_adapter *padater, struct io_req *pio_req, u8 *cnxt), u8 *cnxt);
470
471 extern void async_write_mem(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
472 extern void async_write_port(_adapter *adapter, u32 addr, u32 cnt, u8 *pmem);
473
474
475 int rtw_init_io_priv(_adapter *padapter, void (*set_intf_ops)(_adapter *padapter,struct _io_ops *pops));
476
477
478 extern uint alloc_io_queue(_adapter *adapter);
479 extern void free_io_queue(_adapter *adapter);
480 extern void async_bus_io(struct io_queue *pio_q);
481 extern void bus_sync_io(struct io_queue *pio_q);
482 extern u32 _ioreq2rwmem(struct io_queue *pio_q);
483 extern void dev_power_down(_adapter * Adapter, u8 bpwrup);
484
485 /*
486 #define RTL_R8(reg)             rtw_read8(padapter, reg)
487 #define RTL_R16(reg)            rtw_read16(padapter, reg)
488 #define RTL_R32(reg)            rtw_read32(padapter, reg)
489 #define RTL_W8(reg, val8)       rtw_write8(padapter, reg, val8)
490 #define RTL_W16(reg, val16)     rtw_write16(padapter, reg, val16)
491 #define RTL_W32(reg, val32)     rtw_write32(padapter, reg, val32)
492 */
493
494 /*
495 #define RTL_W8_ASYNC(reg, val8) rtw_write32_async(padapter, reg, val8)
496 #define RTL_W16_ASYNC(reg, val16) rtw_write32_async(padapter, reg, val16)
497 #define RTL_W32_ASYNC(reg, val32) rtw_write32_async(padapter, reg, val32)
498
499 #define RTL_WRITE_BB(reg, val32)        phy_SetUsbBBReg(padapter, reg, val32)
500 #define RTL_READ_BB(reg)        phy_QueryUsbBBReg(padapter, reg)
501 */
502
503 #define PlatformEFIOWrite1Byte(_a,_b,_c)                \
504         rtw_write8(_a,_b,_c)
505 #define PlatformEFIOWrite2Byte(_a,_b,_c)                \
506         rtw_write16(_a,_b,_c)
507 #define PlatformEFIOWrite4Byte(_a,_b,_c)                \
508         rtw_write32(_a,_b,_c)
509
510 #define PlatformEFIORead1Byte(_a,_b)            \
511                 rtw_read8(_a,_b)
512 #define PlatformEFIORead2Byte(_a,_b)            \
513                 rtw_read16(_a,_b)
514 #define PlatformEFIORead4Byte(_a,_b)            \
515                 rtw_read32(_a,_b)
516
517 #endif  //_RTL8711_IO_H_
518