2 * Marvell Wireless LAN device driver: SDIO specific definitions
4 * Copyright (C) 2011-2014, Marvell International Ltd.
6 * This software file (the "File") is distributed by Marvell International
7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8 * (the "License"). You may use, redistribute and/or modify this File in
9 * accordance with the terms and conditions of the License, a copy of which
10 * is available by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
14 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
16 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
17 * this warranty disclaimer.
20 #ifndef _MWIFIEX_SDIO_H
21 #define _MWIFIEX_SDIO_H
24 #include <linux/mmc/sdio.h>
25 #include <linux/mmc/sdio_ids.h>
26 #include <linux/mmc/sdio_func.h>
27 #include <linux/mmc/card.h>
28 #include <linux/mmc/host.h>
32 #define SD8786_DEFAULT_FW_NAME "mrvl/sd8786_uapsta.bin"
33 #define SD8787_DEFAULT_FW_NAME "mrvl/sd8787_uapsta.bin"
34 #define SD8797_DEFAULT_FW_NAME "mrvl/sd8797_uapsta.bin"
35 #define SD8897_DEFAULT_FW_NAME "mrvl/sd8897_uapsta.bin"
36 #define SD8887_DEFAULT_FW_NAME "mrvl/sd8887_uapsta.bin"
37 #define SD8801_DEFAULT_FW_NAME "mrvl/sd8801_uapsta.bin"
38 #define SD8997_DEFAULT_FW_NAME "mrvl/sd8997_uapsta.bin"
45 #define MWIFIEX_SDIO_IO_PORT_MASK 0xfffff
47 #define MWIFIEX_SDIO_BYTE_MODE_MASK 0x80000000
49 #define MWIFIEX_MAX_FUNC2_REG_NUM 13
50 #define MWIFIEX_SDIO_SCRATCH_SIZE 10
52 #define SDIO_MPA_ADDR_BASE 0x1000
54 #define CTRL_PORT_MASK 0x0001
56 #define CMD_PORT_UPLD_INT_MASK (0x1U<<6)
57 #define CMD_PORT_DNLD_INT_MASK (0x1U<<7)
58 #define HOST_TERM_CMD53 (0x1U << 2)
60 #define MEM_PORT 0x10000
62 #define CMD53_NEW_MODE (0x1U << 0)
63 #define CMD_PORT_RD_LEN_EN (0x1U << 2)
64 #define CMD_PORT_AUTO_EN (0x1U << 0)
65 #define CMD_PORT_SLCT 0x8000
66 #define UP_LD_CMD_PORT_HOST_INT_STATUS (0x40U)
67 #define DN_LD_CMD_PORT_HOST_INT_STATUS (0x80U)
69 #define MWIFIEX_MP_AGGR_BUF_SIZE_16K (16384)
70 #define MWIFIEX_MP_AGGR_BUF_SIZE_32K (32768)
71 /* we leave one block of 256 bytes for DMA alignment*/
72 #define MWIFIEX_MP_AGGR_BUF_SIZE_MAX (65280)
74 /* Misc. Config Register : Auto Re-enable interrupts */
75 #define AUTO_RE_ENABLE_INT BIT(4)
77 /* Host Control Registers : Configuration */
78 #define CONFIGURATION_REG 0x00
79 /* Host Control Registers : Host power up */
80 #define HOST_POWER_UP (0x1U << 1)
82 /* Host Control Registers : Upload host interrupt mask */
83 #define UP_LD_HOST_INT_MASK (0x1U)
84 /* Host Control Registers : Download host interrupt mask */
85 #define DN_LD_HOST_INT_MASK (0x2U)
87 /* Host Control Registers : Upload host interrupt status */
88 #define UP_LD_HOST_INT_STATUS (0x1U)
89 /* Host Control Registers : Download host interrupt status */
90 #define DN_LD_HOST_INT_STATUS (0x2U)
92 /* Host Control Registers : Host interrupt status */
93 #define CARD_INT_STATUS_REG 0x28
95 /* Card Control Registers : Card I/O ready */
96 #define CARD_IO_READY (0x1U << 3)
97 /* Card Control Registers : Download card ready */
98 #define DN_LD_CARD_RDY (0x1U << 0)
100 /* Max retry number of CMD53 write */
101 #define MAX_WRITE_IOMEM_RETRY 2
103 /* SDIO Tx aggregation in progress ? */
104 #define MP_TX_AGGR_IN_PROGRESS(a) (a->mpa_tx.pkt_cnt > 0)
106 /* SDIO Tx aggregation buffer room for next packet ? */
107 #define MP_TX_AGGR_BUF_HAS_ROOM(a, len) ((a->mpa_tx.buf_len+len) \
108 <= a->mpa_tx.buf_size)
110 /* Copy current packet (SDIO Tx aggregation buffer) to SDIO buffer */
111 #define MP_TX_AGGR_BUF_PUT(a, payload, pkt_len, port) do { \
112 memmove(&a->mpa_tx.buf[a->mpa_tx.buf_len], \
114 a->mpa_tx.buf_len += pkt_len; \
115 if (!a->mpa_tx.pkt_cnt) \
116 a->mpa_tx.start_port = port; \
117 if (a->mpa_tx.start_port <= port) \
118 a->mpa_tx.ports |= (1<<(a->mpa_tx.pkt_cnt)); \
120 a->mpa_tx.ports |= (1<<(a->mpa_tx.pkt_cnt+1+ \
123 a->mpa_tx.pkt_cnt++; \
126 /* SDIO Tx aggregation limit ? */
127 #define MP_TX_AGGR_PKT_LIMIT_REACHED(a) \
128 (a->mpa_tx.pkt_cnt == a->mpa_tx.pkt_aggr_limit)
130 /* Reset SDIO Tx aggregation buffer parameters */
131 #define MP_TX_AGGR_BUF_RESET(a) do { \
132 a->mpa_tx.pkt_cnt = 0; \
133 a->mpa_tx.buf_len = 0; \
134 a->mpa_tx.ports = 0; \
135 a->mpa_tx.start_port = 0; \
138 /* SDIO Rx aggregation limit ? */
139 #define MP_RX_AGGR_PKT_LIMIT_REACHED(a) \
140 (a->mpa_rx.pkt_cnt == a->mpa_rx.pkt_aggr_limit)
142 /* SDIO Rx aggregation in progress ? */
143 #define MP_RX_AGGR_IN_PROGRESS(a) (a->mpa_rx.pkt_cnt > 0)
145 /* SDIO Rx aggregation buffer room for next packet ? */
146 #define MP_RX_AGGR_BUF_HAS_ROOM(a, rx_len) \
147 ((a->mpa_rx.buf_len+rx_len) <= a->mpa_rx.buf_size)
149 /* Reset SDIO Rx aggregation buffer parameters */
150 #define MP_RX_AGGR_BUF_RESET(a) do { \
151 a->mpa_rx.pkt_cnt = 0; \
152 a->mpa_rx.buf_len = 0; \
153 a->mpa_rx.ports = 0; \
154 a->mpa_rx.start_port = 0; \
157 struct mwifiex_plt_wake_cfg
{
162 /* data structure for SDIO MPA TX */
163 struct mwifiex_sdio_mpa_tx
{
164 /* multiport tx aggregation buffer pointer */
175 struct mwifiex_sdio_mpa_rx
{
182 struct sk_buff
**skb_arr
;
190 int mwifiex_bus_register(void);
191 void mwifiex_bus_unregister(void);
193 struct mwifiex_sdio_card_reg
{
201 u8 host_int_status_reg
;
202 u8 host_int_mask_reg
;
221 u8 card_misc_cfg_reg
;
231 u8 fw_dump_host_ready
;
235 u8 func1_dump_reg_start
;
236 u8 func1_dump_reg_end
;
237 u8 func1_scratch_reg
;
238 u8 func1_spec_reg_num
;
239 u8 func1_spec_reg_table
[MWIFIEX_MAX_FUNC2_REG_NUM
];
242 struct sdio_mmc_card
{
243 struct sdio_func
*func
;
244 struct mwifiex_adapter
*adapter
;
245 struct device_node
*plt_of_node
;
246 struct mwifiex_plt_wake_cfg
*plt_wake_cfg
;
248 const char *firmware
;
249 const struct mwifiex_sdio_card_reg
*reg
;
253 u32 mp_tx_agg_buf_size
;
254 u32 mp_rx_agg_buf_size
;
260 u32 mp_data_port_mask
;
266 bool supports_sdio_new_mode
;
267 bool has_control_mask
;
273 struct mwifiex_sdio_mpa_tx mpa_tx
;
274 struct mwifiex_sdio_mpa_rx mpa_rx
;
276 /* needed for card reset */
277 const struct sdio_device_id
*device_id
;
280 struct mwifiex_sdio_device
{
281 const char *firmware
;
282 const struct mwifiex_sdio_card_reg
*reg
;
286 u32 mp_tx_agg_buf_size
;
287 u32 mp_rx_agg_buf_size
;
288 bool supports_sdio_new_mode
;
289 bool has_control_mask
;
296 static const struct mwifiex_sdio_card_reg mwifiex_reg_sd87xx
= {
299 .base_0_reg
= 0x0040,
300 .base_1_reg
= 0x0041,
302 .host_int_enable
= UP_LD_HOST_INT_MASK
| DN_LD_HOST_INT_MASK
,
303 .host_int_rsr_reg
= 0x1,
304 .host_int_mask_reg
= 0x02,
305 .host_int_status_reg
= 0x03,
306 .status_reg_0
= 0x60,
307 .status_reg_1
= 0x61,
308 .sdio_int_mask
= 0x3f,
309 .data_port_mask
= 0x0000fffe,
310 .io_port_0_reg
= 0x78,
311 .io_port_1_reg
= 0x79,
312 .io_port_2_reg
= 0x7A,
320 .card_misc_cfg_reg
= 0x6c,
321 .func1_dump_reg_start
= 0x0,
322 .func1_dump_reg_end
= 0x9,
323 .func1_scratch_reg
= 0x60,
324 .func1_spec_reg_num
= 5,
325 .func1_spec_reg_table
= {0x28, 0x30, 0x34, 0x38, 0x3c},
328 static const struct mwifiex_sdio_card_reg mwifiex_reg_sd8897
= {
334 .host_int_enable
= UP_LD_HOST_INT_MASK
| DN_LD_HOST_INT_MASK
|
335 CMD_PORT_UPLD_INT_MASK
| CMD_PORT_DNLD_INT_MASK
,
336 .host_int_rsr_reg
= 0x1,
337 .host_int_status_reg
= 0x03,
338 .host_int_mask_reg
= 0x02,
339 .status_reg_0
= 0xc0,
340 .status_reg_1
= 0xc1,
341 .sdio_int_mask
= 0xff,
342 .data_port_mask
= 0xffffffff,
343 .io_port_0_reg
= 0xD8,
344 .io_port_1_reg
= 0xD9,
345 .io_port_2_reg
= 0xDA,
349 .rd_bitmap_1l
= 0x06,
350 .rd_bitmap_1u
= 0x07,
353 .wr_bitmap_1l
= 0x0a,
354 .wr_bitmap_1u
= 0x0b,
357 .card_misc_cfg_reg
= 0xcc,
358 .card_cfg_2_1_reg
= 0xcd,
359 .cmd_rd_len_0
= 0xb4,
360 .cmd_rd_len_1
= 0xb5,
361 .cmd_rd_len_2
= 0xb6,
362 .cmd_rd_len_3
= 0xb7,
367 .fw_dump_host_ready
= 0xee,
368 .fw_dump_ctrl
= 0xe2,
369 .fw_dump_start
= 0xe3,
371 .func1_dump_reg_start
= 0x0,
372 .func1_dump_reg_end
= 0xb,
373 .func1_scratch_reg
= 0xc0,
374 .func1_spec_reg_num
= 8,
375 .func1_spec_reg_table
= {0x4C, 0x50, 0x54, 0x55, 0x58,
379 static const struct mwifiex_sdio_card_reg mwifiex_reg_sd8997
= {
385 .host_int_enable
= UP_LD_HOST_INT_MASK
| DN_LD_HOST_INT_MASK
|
386 CMD_PORT_UPLD_INT_MASK
| CMD_PORT_DNLD_INT_MASK
,
387 .host_int_rsr_reg
= 0x4,
388 .host_int_status_reg
= 0x0C,
389 .host_int_mask_reg
= 0x08,
390 .status_reg_0
= 0xE8,
391 .status_reg_1
= 0xE9,
392 .sdio_int_mask
= 0xff,
393 .data_port_mask
= 0xffffffff,
394 .io_port_0_reg
= 0xE4,
395 .io_port_1_reg
= 0xE5,
396 .io_port_2_reg
= 0xE6,
400 .rd_bitmap_1l
= 0x12,
401 .rd_bitmap_1u
= 0x13,
404 .wr_bitmap_1l
= 0x16,
405 .wr_bitmap_1u
= 0x17,
408 .card_misc_cfg_reg
= 0xd8,
409 .card_cfg_2_1_reg
= 0xd9,
410 .cmd_rd_len_0
= 0xc0,
411 .cmd_rd_len_1
= 0xc1,
412 .cmd_rd_len_2
= 0xc2,
413 .cmd_rd_len_3
= 0xc3,
418 .fw_dump_host_ready
= 0xcc,
419 .fw_dump_ctrl
= 0xf0,
420 .fw_dump_start
= 0xf1,
422 .func1_dump_reg_start
= 0x10,
423 .func1_dump_reg_end
= 0x17,
424 .func1_scratch_reg
= 0xe8,
425 .func1_spec_reg_num
= 13,
426 .func1_spec_reg_table
= {0x08, 0x58, 0x5C, 0x5D,
427 0x60, 0x61, 0x62, 0x64,
428 0x65, 0x66, 0x68, 0x69,
432 static const struct mwifiex_sdio_card_reg mwifiex_reg_sd8887
= {
438 .host_int_enable
= UP_LD_HOST_INT_MASK
| DN_LD_HOST_INT_MASK
|
439 CMD_PORT_UPLD_INT_MASK
| CMD_PORT_DNLD_INT_MASK
,
440 .host_int_rsr_reg
= 0x4,
441 .host_int_status_reg
= 0x0C,
442 .host_int_mask_reg
= 0x08,
443 .status_reg_0
= 0x90,
444 .status_reg_1
= 0x91,
445 .sdio_int_mask
= 0xff,
446 .data_port_mask
= 0xffffffff,
447 .io_port_0_reg
= 0xE4,
448 .io_port_1_reg
= 0xE5,
449 .io_port_2_reg
= 0xE6,
453 .rd_bitmap_1l
= 0x12,
454 .rd_bitmap_1u
= 0x13,
457 .wr_bitmap_1l
= 0x16,
458 .wr_bitmap_1u
= 0x17,
461 .card_misc_cfg_reg
= 0xd8,
462 .card_cfg_2_1_reg
= 0xd9,
463 .cmd_rd_len_0
= 0xc0,
464 .cmd_rd_len_1
= 0xc1,
465 .cmd_rd_len_2
= 0xc2,
466 .cmd_rd_len_3
= 0xc3,
471 .func1_dump_reg_start
= 0x10,
472 .func1_dump_reg_end
= 0x17,
473 .func1_scratch_reg
= 0x90,
474 .func1_spec_reg_num
= 13,
475 .func1_spec_reg_table
= {0x08, 0x58, 0x5C, 0x5D, 0x60,
476 0x61, 0x62, 0x64, 0x65, 0x66,
480 static const struct mwifiex_sdio_device mwifiex_sdio_sd8786
= {
481 .firmware
= SD8786_DEFAULT_FW_NAME
,
482 .reg
= &mwifiex_reg_sd87xx
,
484 .mp_agg_pkt_limit
= 8,
485 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
,
486 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
487 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
488 .supports_sdio_new_mode
= false,
489 .has_control_mask
= true,
490 .can_dump_fw
= false,
491 .can_auto_tdls
= false,
492 .can_ext_scan
= false,
495 static const struct mwifiex_sdio_device mwifiex_sdio_sd8787
= {
496 .firmware
= SD8787_DEFAULT_FW_NAME
,
497 .reg
= &mwifiex_reg_sd87xx
,
499 .mp_agg_pkt_limit
= 8,
500 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
,
501 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
502 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
503 .supports_sdio_new_mode
= false,
504 .has_control_mask
= true,
505 .can_dump_fw
= false,
506 .can_auto_tdls
= false,
507 .can_ext_scan
= true,
510 static const struct mwifiex_sdio_device mwifiex_sdio_sd8797
= {
511 .firmware
= SD8797_DEFAULT_FW_NAME
,
512 .reg
= &mwifiex_reg_sd87xx
,
514 .mp_agg_pkt_limit
= 8,
515 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
,
516 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
517 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
518 .supports_sdio_new_mode
= false,
519 .has_control_mask
= true,
520 .can_dump_fw
= false,
521 .can_auto_tdls
= false,
522 .can_ext_scan
= true,
525 static const struct mwifiex_sdio_device mwifiex_sdio_sd8897
= {
526 .firmware
= SD8897_DEFAULT_FW_NAME
,
527 .reg
= &mwifiex_reg_sd8897
,
529 .mp_agg_pkt_limit
= 16,
530 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_4K
,
531 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_MAX
,
532 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_MAX
,
533 .supports_sdio_new_mode
= true,
534 .has_control_mask
= false,
536 .can_auto_tdls
= false,
537 .can_ext_scan
= true,
540 static const struct mwifiex_sdio_device mwifiex_sdio_sd8997
= {
541 .firmware
= SD8997_DEFAULT_FW_NAME
,
542 .reg
= &mwifiex_reg_sd8997
,
544 .mp_agg_pkt_limit
= 16,
545 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_4K
,
546 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_MAX
,
547 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_MAX
,
548 .supports_sdio_new_mode
= true,
549 .has_control_mask
= false,
552 .can_auto_tdls
= false,
553 .can_ext_scan
= true,
556 static const struct mwifiex_sdio_device mwifiex_sdio_sd8887
= {
557 .firmware
= SD8887_DEFAULT_FW_NAME
,
558 .reg
= &mwifiex_reg_sd8887
,
560 .mp_agg_pkt_limit
= 16,
561 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
,
562 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_32K
,
563 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_32K
,
564 .supports_sdio_new_mode
= true,
565 .has_control_mask
= false,
566 .can_dump_fw
= false,
567 .can_auto_tdls
= true,
568 .can_ext_scan
= true,
571 static const struct mwifiex_sdio_device mwifiex_sdio_sd8801
= {
572 .firmware
= SD8801_DEFAULT_FW_NAME
,
573 .reg
= &mwifiex_reg_sd87xx
,
575 .mp_agg_pkt_limit
= 8,
576 .supports_sdio_new_mode
= false,
577 .has_control_mask
= true,
578 .tx_buf_size
= MWIFIEX_TX_DATA_BUF_SIZE_2K
,
579 .mp_tx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
580 .mp_rx_agg_buf_size
= MWIFIEX_MP_AGGR_BUF_SIZE_16K
,
581 .can_dump_fw
= false,
582 .can_auto_tdls
= false,
583 .can_ext_scan
= true,
587 * .cmdrsp_complete handler
589 static inline int mwifiex_sdio_cmdrsp_complete(struct mwifiex_adapter
*adapter
,
592 dev_kfree_skb_any(skb
);
597 * .event_complete handler
599 static inline int mwifiex_sdio_event_complete(struct mwifiex_adapter
*adapter
,
602 dev_kfree_skb_any(skb
);
607 mp_rx_aggr_port_limit_reached(struct sdio_mmc_card
*card
)
611 if (card
->curr_rd_port
< card
->mpa_rx
.start_port
) {
612 if (card
->supports_sdio_new_mode
)
613 tmp
= card
->mp_end_port
>> 1;
615 tmp
= card
->mp_agg_pkt_limit
;
617 if (((card
->max_ports
- card
->mpa_rx
.start_port
) +
618 card
->curr_rd_port
) >= tmp
)
622 if (!card
->supports_sdio_new_mode
)
625 if ((card
->curr_rd_port
- card
->mpa_rx
.start_port
) >=
626 (card
->mp_end_port
>> 1))
633 mp_tx_aggr_port_limit_reached(struct sdio_mmc_card
*card
)
637 if (card
->curr_wr_port
< card
->mpa_tx
.start_port
) {
638 if (card
->supports_sdio_new_mode
)
639 tmp
= card
->mp_end_port
>> 1;
641 tmp
= card
->mp_agg_pkt_limit
;
643 if (((card
->max_ports
- card
->mpa_tx
.start_port
) +
644 card
->curr_wr_port
) >= tmp
)
648 if (!card
->supports_sdio_new_mode
)
651 if ((card
->curr_wr_port
- card
->mpa_tx
.start_port
) >=
652 (card
->mp_end_port
>> 1))
658 /* Prepare to copy current packet from card to SDIO Rx aggregation buffer */
659 static inline void mp_rx_aggr_setup(struct sdio_mmc_card
*card
,
662 card
->mpa_rx
.buf_len
+= rx_len
;
664 if (!card
->mpa_rx
.pkt_cnt
)
665 card
->mpa_rx
.start_port
= port
;
667 if (card
->supports_sdio_new_mode
) {
668 card
->mpa_rx
.ports
|= (1 << port
);
670 if (card
->mpa_rx
.start_port
<= port
)
671 card
->mpa_rx
.ports
|= 1 << (card
->mpa_rx
.pkt_cnt
);
673 card
->mpa_rx
.ports
|= 1 << (card
->mpa_rx
.pkt_cnt
+ 1);
675 card
->mpa_rx
.skb_arr
[card
->mpa_rx
.pkt_cnt
] = NULL
;
676 card
->mpa_rx
.len_arr
[card
->mpa_rx
.pkt_cnt
] = rx_len
;
677 card
->mpa_rx
.pkt_cnt
++;
679 #endif /* _MWIFIEX_SDIO_H */