1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * This file is part of wlcore
5 * Copyright (C) 2011 Texas Instruments Inc.
11 #include <linux/platform_device.h>
17 /* The maximum number of Tx descriptors in all chip families */
18 #define WLCORE_MAX_TX_DESCRIPTORS 32
21 * We always allocate this number of mac addresses. If we don't
22 * have enough allocated addresses, the LAA bit is used
24 #define WLCORE_NUM_MAC_ADDRESSES 3
26 /* wl12xx/wl18xx maximum transmission power (in dBm) */
27 #define WLCORE_MAX_TXPWR 25
29 /* Texas Instruments pre assigned OUI */
30 #define WLCORE_TI_OUI_ADDRESS 0x080028
32 /* forward declaration */
33 struct wl1271_tx_hw_descr
;
35 struct wl1271_rx_descriptor
;
38 int (*setup
)(struct wl1271
*wl
);
39 int (*identify_chip
)(struct wl1271
*wl
);
40 int (*identify_fw
)(struct wl1271
*wl
);
41 int (*boot
)(struct wl1271
*wl
);
42 int (*plt_init
)(struct wl1271
*wl
);
43 int (*trigger_cmd
)(struct wl1271
*wl
, int cmd_box_addr
,
44 void *buf
, size_t len
);
45 int (*ack_event
)(struct wl1271
*wl
);
46 int (*wait_for_event
)(struct wl1271
*wl
, enum wlcore_wait_event event
,
48 int (*process_mailbox_events
)(struct wl1271
*wl
);
49 u32 (*calc_tx_blocks
)(struct wl1271
*wl
, u32 len
, u32 spare_blks
);
50 void (*set_tx_desc_blocks
)(struct wl1271
*wl
,
51 struct wl1271_tx_hw_descr
*desc
,
52 u32 blks
, u32 spare_blks
);
53 void (*set_tx_desc_data_len
)(struct wl1271
*wl
,
54 struct wl1271_tx_hw_descr
*desc
,
56 enum wl_rx_buf_align (*get_rx_buf_align
)(struct wl1271
*wl
,
58 int (*prepare_read
)(struct wl1271
*wl
, u32 rx_desc
, u32 len
);
59 u32 (*get_rx_packet_len
)(struct wl1271
*wl
, void *rx_data
,
61 int (*tx_delayed_compl
)(struct wl1271
*wl
);
62 void (*tx_immediate_compl
)(struct wl1271
*wl
);
63 int (*hw_init
)(struct wl1271
*wl
);
64 int (*init_vif
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
65 void (*convert_fw_status
)(struct wl1271
*wl
, void *raw_fw_status
,
66 struct wl_fw_status
*fw_status
);
67 u32 (*sta_get_ap_rate_mask
)(struct wl1271
*wl
,
68 struct wl12xx_vif
*wlvif
);
69 int (*get_pg_ver
)(struct wl1271
*wl
, s8
*ver
);
70 int (*get_mac
)(struct wl1271
*wl
);
71 void (*set_tx_desc_csum
)(struct wl1271
*wl
,
72 struct wl1271_tx_hw_descr
*desc
,
74 void (*set_rx_csum
)(struct wl1271
*wl
,
75 struct wl1271_rx_descriptor
*desc
,
77 u32 (*ap_get_mimo_wide_rate_mask
)(struct wl1271
*wl
,
78 struct wl12xx_vif
*wlvif
);
79 int (*debugfs_init
)(struct wl1271
*wl
, struct dentry
*rootdir
);
80 int (*handle_static_data
)(struct wl1271
*wl
,
81 struct wl1271_static_data
*static_data
);
82 int (*scan_start
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
,
83 struct cfg80211_scan_request
*req
);
84 int (*scan_stop
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
85 int (*sched_scan_start
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
,
86 struct cfg80211_sched_scan_request
*req
,
87 struct ieee80211_scan_ies
*ies
);
88 void (*sched_scan_stop
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
89 int (*get_spare_blocks
)(struct wl1271
*wl
, bool is_gem
);
90 int (*set_key
)(struct wl1271
*wl
, enum set_key_cmd cmd
,
91 struct ieee80211_vif
*vif
,
92 struct ieee80211_sta
*sta
,
93 struct ieee80211_key_conf
*key_conf
);
94 int (*channel_switch
)(struct wl1271
*wl
,
95 struct wl12xx_vif
*wlvif
,
96 struct ieee80211_channel_switch
*ch_switch
);
97 u32 (*pre_pkt_send
)(struct wl1271
*wl
, u32 buf_offset
, u32 last_len
);
98 void (*sta_rc_update
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
99 int (*set_peer_cap
)(struct wl1271
*wl
,
100 struct ieee80211_sta_ht_cap
*ht_cap
,
101 bool allow_ht_operation
,
102 u32 rate_set
, u8 hlid
);
103 u32 (*convert_hwaddr
)(struct wl1271
*wl
, u32 hwaddr
);
104 bool (*lnk_high_prio
)(struct wl1271
*wl
, u8 hlid
,
105 struct wl1271_link
*lnk
);
106 bool (*lnk_low_prio
)(struct wl1271
*wl
, u8 hlid
,
107 struct wl1271_link
*lnk
);
108 int (*interrupt_notify
)(struct wl1271
*wl
, bool action
);
109 int (*rx_ba_filter
)(struct wl1271
*wl
, bool action
);
110 int (*ap_sleep
)(struct wl1271
*wl
);
111 int (*smart_config_start
)(struct wl1271
*wl
, u32 group_bitmap
);
112 int (*smart_config_stop
)(struct wl1271
*wl
);
113 int (*smart_config_set_group_key
)(struct wl1271
*wl
, u16 group_id
,
114 u8 key_len
, u8
*key
);
115 int (*set_cac
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
,
117 int (*dfs_master_restart
)(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
);
120 enum wlcore_partitions
{
125 PART_TOP_PRCM_ELP_SOC
,
131 struct wlcore_partition
{
136 struct wlcore_partition_set
{
137 struct wlcore_partition mem
;
138 struct wlcore_partition reg
;
139 struct wlcore_partition mem2
;
140 struct wlcore_partition mem3
;
143 enum wlcore_registers
{
144 /* register addresses, used with partition translation */
146 REG_INTERRUPT_NO_CLEAR
,
148 REG_COMMAND_MAILBOX_PTR
,
149 REG_EVENT_MAILBOX_PTR
,
154 REG_CMD_MBOX_ADDRESS
,
156 /* data access memory addresses, used with partition translation */
160 /* raw data access memory addresses */
161 REG_RAW_FW_STATUS_ADDR
,
166 struct wl1271_stats
{
168 unsigned long fw_stats_update
;
171 unsigned int retry_count
;
172 unsigned int excessive_retries
;
177 struct ieee80211_hw
*hw
;
178 bool mac80211_registered
;
181 struct platform_device
*pdev
;
185 struct wl1271_if_operations
*if_ops
;
195 enum wlcore_state state
;
196 enum wl12xx_fw_type fw_type
;
198 enum plt_mode plt_mode
;
205 struct wlcore_partition_set curr_part
;
207 struct wl1271_chip chip
;
218 /* address read from the fuse ROM */
222 /* we have up to 2 MAC addresses */
223 struct mac_address addresses
[WLCORE_NUM_MAC_ADDRESSES
];
227 unsigned long links_map
[BITS_TO_LONGS(WLCORE_MAX_LINKS
)];
228 unsigned long roles_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
229 unsigned long roc_map
[BITS_TO_LONGS(WL12XX_MAX_ROLES
)];
230 unsigned long rate_policies_map
[
231 BITS_TO_LONGS(WL12XX_MAX_RATE_POLICIES
)];
232 unsigned long klv_templates_map
[
233 BITS_TO_LONGS(WLCORE_MAX_KLV_TEMPLATES
)];
235 u8 session_ids
[WLCORE_MAX_LINKS
];
237 struct list_head wlvif_list
;
242 struct wl1271_acx_mem_map
*target_mem_map
;
244 /* Accounting for allocated / available TX blocks on HW */
246 u32 tx_blocks_available
;
247 u32 tx_allocated_blocks
;
248 u32 tx_results_count
;
250 /* Accounting for allocated / available Tx packets in HW */
251 u32 tx_pkts_freed
[NUM_TX_QUEUES
];
252 u32 tx_allocated_pkts
[NUM_TX_QUEUES
];
254 /* Transmitted TX packets counter for chipset interface */
255 u32 tx_packets_count
;
257 /* Time-offset between host and chipset clocks */
260 /* Frames scheduled for transmission, not handled yet */
261 int tx_queue_count
[NUM_TX_QUEUES
];
262 unsigned long queue_stop_reasons
[
263 NUM_TX_QUEUES
* WLCORE_NUM_MAC_ADDRESSES
];
265 /* Frames received, not handled yet by mac80211 */
266 struct sk_buff_head deferred_rx_queue
;
268 /* Frames sent, not returned yet to mac80211 */
269 struct sk_buff_head deferred_tx_queue
;
271 struct work_struct tx_work
;
272 struct workqueue_struct
*freezable_wq
;
274 /* Pending TX frames */
275 unsigned long tx_frames_map
[BITS_TO_LONGS(WLCORE_MAX_TX_DESCRIPTORS
)];
276 struct sk_buff
*tx_frames
[WLCORE_MAX_TX_DESCRIPTORS
];
282 /* Intermediate buffer, used for packet aggregation */
286 /* Reusable dummy packet template */
287 struct sk_buff
*dummy_packet
;
289 /* Network stack work */
290 struct work_struct netstack_work
;
295 /* Number of valid bytes in the FW log buffer */
298 /* FW log end marker */
301 /* FW memory block size */
302 u32 fw_mem_block_size
;
304 /* Hardware recovery work */
305 struct work_struct recovery_work
;
306 bool watchdog_recovery
;
308 /* Reg domain last configuration */
309 DECLARE_BITMAP(reg_ch_conf_last
, 64);
310 /* Reg domain pending configuration */
311 DECLARE_BITMAP(reg_ch_conf_pending
, 64);
313 /* Pointer that holds DMA-friendly block for the mailbox */
316 /* The mbox event mask */
318 /* events to unmask only when ap interface is up */
321 /* Mailbox pointers */
325 /* Are we currently scanning */
326 struct wl12xx_vif
*scan_wlvif
;
327 struct wl1271_scan scan
;
328 struct delayed_work scan_complete_work
;
330 struct ieee80211_vif
*roc_vif
;
331 struct delayed_work roc_complete_work
;
333 struct wl12xx_vif
*sched_vif
;
335 /* The current band */
336 enum nl80211_band band
;
338 struct completion
*elp_compl
;
343 struct wl1271_stats stats
;
347 u32 buffer_busyword
[WL1271_BUSY_WORD_CNT
];
350 struct wl_fw_status
*fw_status
;
351 struct wl1271_tx_hw_res_if
*tx_res_if
;
353 /* Current chipset configuration */
354 struct wlcore_conf conf
;
362 /* Most recently reported noise in dBm */
365 /* bands supported by this instance of wl12xx */
366 struct ieee80211_supported_band bands
[WLCORE_NUM_BANDS
];
369 * wowlan trigger was configured during suspend.
370 * (currently, only "ANY" trigger is supported)
373 bool irq_wake_enabled
;
376 * AP-mode - links indexed by HLID. The global and broadcast links
379 struct wl1271_link links
[WLCORE_MAX_LINKS
];
381 /* number of currently active links */
382 int active_link_count
;
384 /* Fast/slow links bitmap according to FW */
385 unsigned long fw_fast_lnk_map
;
387 /* AP-mode - a bitmap of links currently in PS mode according to FW */
388 unsigned long ap_fw_ps_map
;
390 /* AP-mode - a bitmap of links currently in PS mode in mac80211 */
391 unsigned long ap_ps_map
;
393 /* Quirks of specific hardware revisions */
396 /* number of currently active RX BA sessions */
397 int ba_rx_session_count
;
399 /* Maximum number of supported RX BA sessions */
400 int ba_rx_session_count_max
;
402 /* AP-mode - number of currently connected stations */
403 int active_sta_count
;
405 /* Flag determining whether AP should broadcast OFDM-only rates */
408 /* last wlvif we transmitted from */
409 struct wl12xx_vif
*last_wlvif
;
411 /* work to fire when Tx is stuck */
412 struct delayed_work tx_watchdog_work
;
414 struct wlcore_ops
*ops
;
415 /* pointer to the lower driver partition table */
416 const struct wlcore_partition_set
*ptable
;
417 /* pointer to the lower driver register table */
419 /* name of the firmwares to load - for PLT, single role, multi-role */
420 const char *plt_fw_name
;
421 const char *sr_fw_name
;
422 const char *mr_fw_name
;
424 u8 scan_templ_id_2_4
;
426 u8 sched_scan_templ_id_2_4
;
427 u8 sched_scan_templ_id_5
;
430 /* per-chip-family private structure */
433 /* number of TX descriptors the HW supports. */
435 /* number of RX descriptors the HW supports. */
437 /* number of links the HW supports */
439 /* max stations a single AP can support */
442 /* translate HW Tx rates to standard rate-indices */
443 const u8
**band_rate_to_idx
;
445 /* size of table for HW rates that can be received from chip */
446 u8 hw_tx_rate_tbl_size
;
448 /* this HW rate and below are considered HT rates for this chip */
451 /* HW HT (11n) capabilities */
452 struct ieee80211_sta_ht_cap ht_cap
[WLCORE_NUM_BANDS
];
454 /* the current dfs region */
455 enum nl80211_dfs_regions dfs_region
;
456 bool radar_debug_mode
;
458 /* size of the private FW status data */
459 size_t fw_status_len
;
460 size_t fw_status_priv_len
;
462 /* RX Data filter rule state - enabled/disabled */
463 unsigned long rx_filter_enabled
[BITS_TO_LONGS(WL1271_MAX_RX_FILTERS
)];
465 /* size of the private static data */
466 size_t static_data_priv_len
;
468 /* the current channel type */
469 enum nl80211_channel_type channel_type
;
471 /* mutex for protecting the tx_flush function */
472 struct mutex flush_mutex
;
474 /* sleep auth value currently configured to FW */
477 /* the number of allocated MAC addresses in this chip */
480 /* minimum FW version required for the driver to work in single-role */
481 unsigned int min_sr_fw_ver
[NUM_FW_VER
];
483 /* minimum FW version required for the driver to work in multi-role */
484 unsigned int min_mr_fw_ver
[NUM_FW_VER
];
486 struct completion nvs_loading_complete
;
488 /* interface combinations supported by the hw */
489 const struct ieee80211_iface_combination
*iface_combinations
;
490 u8 n_iface_combinations
;
492 /* dynamic fw traces */
493 u32 dynamic_fw_traces
;
495 /* time sync zone master */
496 u8 zone_master_mac_addr
[ETH_ALEN
];
499 int wlcore_probe(struct wl1271
*wl
, struct platform_device
*pdev
);
500 int wlcore_remove(struct platform_device
*pdev
);
501 struct ieee80211_hw
*wlcore_alloc_hw(size_t priv_size
, u32 aggr_buf_size
,
503 int wlcore_free_hw(struct wl1271
*wl
);
504 int wlcore_set_key(struct wl1271
*wl
, enum set_key_cmd cmd
,
505 struct ieee80211_vif
*vif
,
506 struct ieee80211_sta
*sta
,
507 struct ieee80211_key_conf
*key_conf
);
508 void wlcore_regdomain_config(struct wl1271
*wl
);
509 void wlcore_update_inconn_sta(struct wl1271
*wl
, struct wl12xx_vif
*wlvif
,
510 struct wl1271_station
*wl_sta
, bool in_conn
);
513 wlcore_set_ht_cap(struct wl1271
*wl
, enum nl80211_band band
,
514 struct ieee80211_sta_ht_cap
*ht_cap
)
516 memcpy(&wl
->ht_cap
[band
], ht_cap
, sizeof(*ht_cap
));
519 /* Tell wlcore not to care about this element when checking the version */
520 #define WLCORE_FW_VER_IGNORE -1
523 wlcore_set_min_fw_ver(struct wl1271
*wl
, unsigned int chip
,
524 unsigned int iftype_sr
, unsigned int major_sr
,
525 unsigned int subtype_sr
, unsigned int minor_sr
,
526 unsigned int iftype_mr
, unsigned int major_mr
,
527 unsigned int subtype_mr
, unsigned int minor_mr
)
529 wl
->min_sr_fw_ver
[FW_VER_CHIP
] = chip
;
530 wl
->min_sr_fw_ver
[FW_VER_IF_TYPE
] = iftype_sr
;
531 wl
->min_sr_fw_ver
[FW_VER_MAJOR
] = major_sr
;
532 wl
->min_sr_fw_ver
[FW_VER_SUBTYPE
] = subtype_sr
;
533 wl
->min_sr_fw_ver
[FW_VER_MINOR
] = minor_sr
;
535 wl
->min_mr_fw_ver
[FW_VER_CHIP
] = chip
;
536 wl
->min_mr_fw_ver
[FW_VER_IF_TYPE
] = iftype_mr
;
537 wl
->min_mr_fw_ver
[FW_VER_MAJOR
] = major_mr
;
538 wl
->min_mr_fw_ver
[FW_VER_SUBTYPE
] = subtype_mr
;
539 wl
->min_mr_fw_ver
[FW_VER_MINOR
] = minor_mr
;
542 /* Firmware image load chunk size */
543 #define CHUNK_SIZE 16384
547 /* Each RX/TX transaction requires an end-of-transaction transfer */
548 #define WLCORE_QUIRK_END_OF_TRANSACTION BIT(0)
550 /* the first start_role(sta) sometimes doesn't work on wl12xx */
551 #define WLCORE_QUIRK_START_STA_FAILS BIT(1)
553 /* wl127x and SPI don't support SDIO block size alignment */
554 #define WLCORE_QUIRK_TX_BLOCKSIZE_ALIGN BIT(2)
556 /* means aggregated Rx packets are aligned to a SDIO block */
557 #define WLCORE_QUIRK_RX_BLOCKSIZE_ALIGN BIT(3)
559 /* Older firmwares did not implement the FW logger over bus feature */
560 #define WLCORE_QUIRK_FWLOG_NOT_IMPLEMENTED BIT(4)
562 /* Older firmwares use an old NVS format */
563 #define WLCORE_QUIRK_LEGACY_NVS BIT(5)
565 /* pad only the last frame in the aggregate buffer */
566 #define WLCORE_QUIRK_TX_PAD_LAST_FRAME BIT(7)
568 /* extra header space is required for TKIP */
569 #define WLCORE_QUIRK_TKIP_HEADER_SPACE BIT(8)
571 /* Some firmwares not support sched scans while connected */
572 #define WLCORE_QUIRK_NO_SCHED_SCAN_WHILE_CONN BIT(9)
574 /* separate probe response templates for one-shot and sched scans */
575 #define WLCORE_QUIRK_DUAL_PROBE_TMPL BIT(10)
577 /* Firmware requires reg domain configuration for active calibration */
578 #define WLCORE_QUIRK_REGDOMAIN_CONF BIT(11)
580 /* The FW only support a zero session id for AP */
581 #define WLCORE_QUIRK_AP_ZERO_SESSION_ID BIT(12)
583 /* TODO: move all these common registers and values elsewhere */
584 #define HW_ACCESS_ELP_CTRL_REG 0x1FFFC
586 /* ELP register commands */
587 #define ELPCTRL_WAKE_UP 0x1
588 #define ELPCTRL_WAKE_UP_WLAN_READY 0x5
589 #define ELPCTRL_SLEEP 0x0
590 /* ELP WLAN_READY bit */
591 #define ELPCTRL_WLAN_READY 0x2
593 /*************************************************************************
595 Interrupt Trigger Register (Host -> WiLink)
597 **************************************************************************/
599 /* Hardware to Embedded CPU Interrupts - first 32-bit register set */
602 * The host sets this bit to inform the Wlan
603 * FW that a TX packet is in the XFER
606 #define INTR_TRIG_TX_PROC0 BIT(2)
609 * The host sets this bit to inform the FW
610 * that it read a packet from RX XFER
613 #define INTR_TRIG_RX_PROC0 BIT(3)
615 #define INTR_TRIG_DEBUG_ACK BIT(4)
617 #define INTR_TRIG_STATE_CHANGED BIT(5)
619 /* Hardware to Embedded CPU Interrupts - second 32-bit register set */
622 * The host sets this bit to inform the FW
623 * that it read a packet from RX XFER
626 #define INTR_TRIG_RX_PROC1 BIT(17)
629 * The host sets this bit to inform the Wlan
630 * hardware that a TX packet is in the XFER
633 #define INTR_TRIG_TX_PROC1 BIT(18)
635 #define ACX_SLV_SOFT_RESET_BIT BIT(1)
636 #define SOFT_RESET_MAX_TIME 1000000
637 #define SOFT_RESET_STALL_TIME 1000
639 #define ECPU_CONTROL_HALT 0x00000101
641 #define WELP_ARM_COMMAND_VAL 0x4
643 #endif /* __WLCORE_H__ */