1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
2 /* Copyright(c) 2019-2020 Realtek Corporation
5 #include <linux/devcoredump.h>
16 #define SER_RECFG_TIMEOUT 1000
22 SER_EV_L1_RESET, /* M1 */
23 SER_EV_DO_RECOVERY, /* M3 */
24 SER_EV_MAC_RESET_DONE, /* M5 */
27 SER_EV_L2_RECFG_TIMEOUT,
43 struct list_head list;
50 void (*st_func)(struct rtw89_ser *ser, u8 event);
58 static char *ser_ev_name(struct rtw89_ser *ser, u8 event)
60 if (event < SER_EV_MAXX)
61 return ser->ev_tbl[event].name;
66 static char *ser_st_name(struct rtw89_ser *ser)
68 if (ser->state < SER_ST_MAX_ST)
69 return ser->st_tbl[ser->state].name;
74 #define RTW89_DEF_SER_CD_TYPE(_name, _type, _size) \
75 struct ser_cd_ ## _name { \
81 static void ser_cd_ ## _name ## _init(struct ser_cd_ ## _name *p) \
84 p->type_size = sizeof(p->data); \
85 p->padding = 0x0123456789abcdef; \
88 enum rtw89_ser_cd_type {
89 RTW89_SER_CD_FW_RSVD_PLE = 0,
90 RTW89_SER_CD_FW_BACKTRACE = 1,
93 RTW89_DEF_SER_CD_TYPE(fw_rsvd_ple,
94 RTW89_SER_CD_FW_RSVD_PLE,
95 RTW89_FW_RSVD_PLE_SIZE);
97 RTW89_DEF_SER_CD_TYPE(fw_backtrace,
98 RTW89_SER_CD_FW_BACKTRACE,
99 RTW89_FW_BACKTRACE_MAX_SIZE);
101 struct rtw89_ser_cd_buffer {
102 struct ser_cd_fw_rsvd_ple fwple;
103 struct ser_cd_fw_backtrace fwbt;
106 static struct rtw89_ser_cd_buffer *rtw89_ser_cd_prep(struct rtw89_dev *rtwdev)
108 struct rtw89_ser_cd_buffer *buf;
110 buf = vzalloc(sizeof(*buf));
114 ser_cd_fw_rsvd_ple_init(&buf->fwple);
115 ser_cd_fw_backtrace_init(&buf->fwbt);
120 static void rtw89_ser_cd_send(struct rtw89_dev *rtwdev,
121 struct rtw89_ser_cd_buffer *buf)
123 rtw89_debug(rtwdev, RTW89_DBG_SER, "SER sends core dump\n");
125 /* After calling dev_coredump, buf's lifetime is supposed to be
126 * handled by the device coredump framework. Note that a new dump
127 * will be discarded if a previous one hasn't been released by
130 dev_coredumpv(rtwdev->dev, buf, sizeof(*buf), GFP_KERNEL);
133 static void rtw89_ser_cd_free(struct rtw89_dev *rtwdev,
134 struct rtw89_ser_cd_buffer *buf, bool free_self)
139 rtw89_debug(rtwdev, RTW89_DBG_SER, "SER frees core dump by self\n");
141 /* When some problems happen during filling data of core dump,
142 * we won't send it to device coredump framework. Instead, we
143 * free buf by ourselves.
148 static void ser_state_run(struct rtw89_ser *ser, u8 evt)
150 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
152 rtw89_debug(rtwdev, RTW89_DBG_SER, "ser: %s receive %s\n",
153 ser_st_name(ser), ser_ev_name(ser, evt));
155 rtw89_leave_lps(rtwdev);
156 ser->st_tbl[ser->state].st_func(ser, evt);
159 static void ser_state_goto(struct rtw89_ser *ser, u8 new_state)
161 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
163 if (ser->state == new_state || new_state >= SER_ST_MAX_ST)
165 ser_state_run(ser, SER_EV_STATE_OUT);
167 rtw89_debug(rtwdev, RTW89_DBG_SER, "ser: %s goto -> %s\n",
168 ser_st_name(ser), ser->st_tbl[new_state].name);
170 ser->state = new_state;
171 ser_state_run(ser, SER_EV_STATE_IN);
174 static struct ser_msg *__rtw89_ser_dequeue_msg(struct rtw89_ser *ser)
178 spin_lock_irq(&ser->msg_q_lock);
179 msg = list_first_entry_or_null(&ser->msg_q, struct ser_msg, list);
181 list_del(&msg->list);
182 spin_unlock_irq(&ser->msg_q_lock);
187 static void rtw89_ser_hdl_work(struct work_struct *work)
190 struct rtw89_ser *ser = container_of(work, struct rtw89_ser,
193 while ((msg = __rtw89_ser_dequeue_msg(ser))) {
194 ser_state_run(ser, msg->event);
199 static int ser_send_msg(struct rtw89_ser *ser, u8 event)
201 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
202 struct ser_msg *msg = NULL;
204 if (test_bit(RTW89_SER_DRV_STOP_RUN, ser->flags))
207 msg = kmalloc(sizeof(*msg), GFP_ATOMIC);
213 spin_lock_irq(&ser->msg_q_lock);
214 list_add(&msg->list, &ser->msg_q);
215 spin_unlock_irq(&ser->msg_q_lock);
217 ieee80211_queue_work(rtwdev->hw, &ser->ser_hdl_work);
221 static void rtw89_ser_alarm_work(struct work_struct *work)
223 struct rtw89_ser *ser = container_of(work, struct rtw89_ser,
224 ser_alarm_work.work);
226 ser_send_msg(ser, ser->alarm_event);
227 ser->alarm_event = SER_EV_NONE;
230 static void ser_set_alarm(struct rtw89_ser *ser, u32 ms, u8 event)
232 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
234 if (test_bit(RTW89_SER_DRV_STOP_RUN, ser->flags))
237 ser->alarm_event = event;
238 ieee80211_queue_delayed_work(rtwdev->hw, &ser->ser_alarm_work,
239 msecs_to_jiffies(ms));
242 static void ser_del_alarm(struct rtw89_ser *ser)
244 cancel_delayed_work(&ser->ser_alarm_work);
245 ser->alarm_event = SER_EV_NONE;
248 /* driver function */
249 static void drv_stop_tx(struct rtw89_ser *ser)
251 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
253 ieee80211_stop_queues(rtwdev->hw);
254 set_bit(RTW89_SER_DRV_STOP_TX, ser->flags);
257 static void drv_stop_rx(struct rtw89_ser *ser)
259 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
261 clear_bit(RTW89_FLAG_RUNNING, rtwdev->flags);
262 set_bit(RTW89_SER_DRV_STOP_RX, ser->flags);
265 static void drv_trx_reset(struct rtw89_ser *ser)
267 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
269 rtw89_hci_reset(rtwdev);
272 static void drv_resume_tx(struct rtw89_ser *ser)
274 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
276 if (!test_bit(RTW89_SER_DRV_STOP_TX, ser->flags))
279 ieee80211_wake_queues(rtwdev->hw);
280 clear_bit(RTW89_SER_DRV_STOP_TX, ser->flags);
283 static void drv_resume_rx(struct rtw89_ser *ser)
285 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
287 if (!test_bit(RTW89_SER_DRV_STOP_RX, ser->flags))
290 set_bit(RTW89_FLAG_RUNNING, rtwdev->flags);
291 clear_bit(RTW89_SER_DRV_STOP_RX, ser->flags);
294 static void ser_reset_vif(struct rtw89_dev *rtwdev, struct rtw89_vif *rtwvif)
296 rtw89_core_release_bit_map(rtwdev->hw_port, rtwvif->port);
297 rtwvif->net_type = RTW89_NET_TYPE_NO_LINK;
298 rtwvif->trigger = false;
301 static void ser_sta_deinit_addr_cam_iter(void *data, struct ieee80211_sta *sta)
303 struct rtw89_dev *rtwdev = (struct rtw89_dev *)data;
304 struct rtw89_sta *rtwsta = (struct rtw89_sta *)sta->drv_priv;
306 rtw89_cam_deinit_addr_cam(rtwdev, &rtwsta->addr_cam);
309 static void ser_deinit_cam(struct rtw89_dev *rtwdev, struct rtw89_vif *rtwvif)
311 if (rtwvif->net_type == RTW89_NET_TYPE_AP_MODE)
312 ieee80211_iterate_stations_atomic(rtwdev->hw,
313 ser_sta_deinit_addr_cam_iter,
316 rtw89_cam_deinit(rtwdev, rtwvif);
319 static void ser_reset_mac_binding(struct rtw89_dev *rtwdev)
321 struct rtw89_vif *rtwvif;
323 rtw89_cam_reset_keys(rtwdev);
324 rtw89_for_each_rtwvif(rtwdev, rtwvif)
325 ser_deinit_cam(rtwdev, rtwvif);
327 rtw89_core_release_all_bits_map(rtwdev->mac_id_map, RTW89_MAX_MAC_ID_NUM);
328 rtw89_for_each_rtwvif(rtwdev, rtwvif)
329 ser_reset_vif(rtwdev, rtwvif);
333 static int hal_enable_dma(struct rtw89_ser *ser)
335 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
338 if (!test_bit(RTW89_SER_HAL_STOP_DMA, ser->flags))
341 if (!rtwdev->hci.ops->mac_lv1_rcvy)
344 ret = rtwdev->hci.ops->mac_lv1_rcvy(rtwdev, RTW89_LV1_RCVY_STEP_2);
346 clear_bit(RTW89_SER_HAL_STOP_DMA, ser->flags);
351 static int hal_stop_dma(struct rtw89_ser *ser)
353 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
356 if (!rtwdev->hci.ops->mac_lv1_rcvy)
359 ret = rtwdev->hci.ops->mac_lv1_rcvy(rtwdev, RTW89_LV1_RCVY_STEP_1);
361 set_bit(RTW89_SER_HAL_STOP_DMA, ser->flags);
366 static void hal_send_m2_event(struct rtw89_ser *ser)
368 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
370 rtw89_mac_set_err_status(rtwdev, MAC_AX_ERR_L1_DISABLE_EN);
373 static void hal_send_m4_event(struct rtw89_ser *ser)
375 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
377 rtw89_mac_set_err_status(rtwdev, MAC_AX_ERR_L1_RCVY_EN);
381 static void ser_idle_st_hdl(struct rtw89_ser *ser, u8 evt)
383 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
386 case SER_EV_STATE_IN:
387 rtw89_hci_recovery_complete(rtwdev);
389 case SER_EV_L1_RESET:
390 ser_state_goto(ser, SER_RESET_TRX_ST);
392 case SER_EV_L2_RESET:
393 ser_state_goto(ser, SER_L2_RESET_ST);
395 case SER_EV_STATE_OUT:
396 rtw89_hci_recovery_start(rtwdev);
403 static void ser_reset_trx_st_hdl(struct rtw89_ser *ser, u8 evt)
406 case SER_EV_STATE_IN:
409 if (hal_stop_dma(ser)) {
410 ser_state_goto(ser, SER_L2_RESET_ST);
418 hal_send_m2_event(ser);
420 /* set alarm to prevent FW response timeout */
421 ser_set_alarm(ser, 1000, SER_EV_M3_TIMEOUT);
424 case SER_EV_DO_RECOVERY:
425 ser_state_goto(ser, SER_DO_HCI_ST);
428 case SER_EV_M3_TIMEOUT:
429 ser_state_goto(ser, SER_L2_RESET_ST);
432 case SER_EV_STATE_OUT:
444 static void ser_do_hci_st_hdl(struct rtw89_ser *ser, u8 evt)
447 case SER_EV_STATE_IN:
449 hal_send_m4_event(ser);
451 /* prevent FW response timeout */
452 ser_set_alarm(ser, 1000, SER_EV_FW_M5_TIMEOUT);
455 case SER_EV_FW_M5_TIMEOUT:
456 ser_state_goto(ser, SER_L2_RESET_ST);
459 case SER_EV_MAC_RESET_DONE:
460 ser_state_goto(ser, SER_IDLE_ST);
463 case SER_EV_STATE_OUT:
472 static void ser_mac_mem_dump(struct rtw89_dev *rtwdev, u8 *buf,
473 u8 sel, u32 start_addr, u32 len)
475 u32 *ptr = (u32 *)buf;
476 u32 base_addr, start_page, residue;
480 start_page = start_addr / MAC_MEM_DUMP_PAGE_SIZE;
481 residue = start_addr % MAC_MEM_DUMP_PAGE_SIZE;
482 base_addr = rtw89_mac_mem_base_addrs[sel];
483 base_addr += start_page * MAC_MEM_DUMP_PAGE_SIZE;
486 rtw89_write32(rtwdev, R_AX_FILTER_MODEL_ADDR, base_addr);
488 for (i = R_AX_INDIR_ACCESS_ENTRY + residue;
489 i < R_AX_INDIR_ACCESS_ENTRY + MAC_MEM_DUMP_PAGE_SIZE;
491 *ptr = rtw89_read32(rtwdev, i);
498 base_addr += MAC_MEM_DUMP_PAGE_SIZE;
502 static void rtw89_ser_fw_rsvd_ple_dump(struct rtw89_dev *rtwdev, u8 *buf)
504 u32 start_addr = rtwdev->chip->rsvd_ple_ofst;
506 rtw89_debug(rtwdev, RTW89_DBG_SER,
507 "dump mem for fw rsvd payload engine (start addr: 0x%x)\n",
509 ser_mac_mem_dump(rtwdev, buf, RTW89_MAC_MEM_SHARED_BUF, start_addr,
510 RTW89_FW_RSVD_PLE_SIZE);
513 struct __fw_backtrace_entry {
519 struct __fw_backtrace_info {
524 static_assert(RTW89_FW_BACKTRACE_INFO_SIZE ==
525 sizeof(struct __fw_backtrace_info));
527 static int rtw89_ser_fw_backtrace_dump(struct rtw89_dev *rtwdev, u8 *buf,
528 const struct __fw_backtrace_entry *ent)
530 struct __fw_backtrace_info *ptr = (struct __fw_backtrace_info *)buf;
531 u32 fwbt_addr = ent->wcpu_addr - RTW89_WCPU_BASE_ADDR;
532 u32 fwbt_size = ent->size;
533 u32 fwbt_key = ent->key;
536 if (fwbt_addr == 0) {
537 rtw89_warn(rtwdev, "FW backtrace invalid address: 0x%x\n",
542 if (fwbt_key != RTW89_FW_BACKTRACE_KEY) {
543 rtw89_warn(rtwdev, "FW backtrace invalid key: 0x%x\n",
548 if (fwbt_size == 0 || !RTW89_VALID_FW_BACKTRACE_SIZE(fwbt_size) ||
549 fwbt_size > RTW89_FW_BACKTRACE_MAX_SIZE) {
550 rtw89_warn(rtwdev, "FW backtrace invalid size: 0x%x\n",
555 rtw89_debug(rtwdev, RTW89_DBG_SER, "dump fw backtrace start\n");
556 rtw89_write32(rtwdev, R_AX_FILTER_MODEL_ADDR, fwbt_addr);
558 for (i = R_AX_INDIR_ACCESS_ENTRY;
559 i < R_AX_INDIR_ACCESS_ENTRY + fwbt_size;
560 i += RTW89_FW_BACKTRACE_INFO_SIZE, ptr++) {
561 *ptr = (struct __fw_backtrace_info){
562 .ra = rtw89_read32(rtwdev, i),
563 .sp = rtw89_read32(rtwdev, i + 4),
565 rtw89_debug(rtwdev, RTW89_DBG_SER,
566 "next sp: 0x%x, next ra: 0x%x\n",
570 rtw89_debug(rtwdev, RTW89_DBG_SER, "dump fw backtrace end\n");
574 static void ser_l2_reset_st_pre_hdl(struct rtw89_ser *ser)
576 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
577 struct rtw89_ser_cd_buffer *buf;
578 struct __fw_backtrace_entry fwbt_ent;
581 buf = rtw89_ser_cd_prep(rtwdev);
587 rtw89_ser_fw_rsvd_ple_dump(rtwdev, buf->fwple.data);
589 fwbt_ent = *(struct __fw_backtrace_entry *)buf->fwple.data;
590 ret = rtw89_ser_fw_backtrace_dump(rtwdev, buf->fwbt.data, &fwbt_ent);
594 rtw89_ser_cd_send(rtwdev, buf);
597 rtw89_ser_cd_free(rtwdev, buf, !!ret);
599 ser_reset_mac_binding(rtwdev);
600 rtw89_core_stop(rtwdev);
601 INIT_LIST_HEAD(&rtwdev->rtwvifs_list);
604 static void ser_l2_reset_st_hdl(struct rtw89_ser *ser, u8 evt)
606 struct rtw89_dev *rtwdev = container_of(ser, struct rtw89_dev, ser);
609 case SER_EV_STATE_IN:
610 mutex_lock(&rtwdev->mutex);
611 ser_l2_reset_st_pre_hdl(ser);
612 mutex_unlock(&rtwdev->mutex);
614 ieee80211_restart_hw(rtwdev->hw);
615 ser_set_alarm(ser, SER_RECFG_TIMEOUT, SER_EV_L2_RECFG_TIMEOUT);
618 case SER_EV_L2_RECFG_TIMEOUT:
619 rtw89_info(rtwdev, "Err: ser L2 re-config timeout\n");
621 case SER_EV_L2_RECFG_DONE:
622 ser_state_goto(ser, SER_IDLE_ST);
623 clear_bit(RTW89_FLAG_RESTART_TRIGGER, rtwdev->flags);
626 case SER_EV_STATE_OUT:
635 static const struct event_ent ser_ev_tbl[] = {
636 {SER_EV_NONE, "SER_EV_NONE"},
637 {SER_EV_STATE_IN, "SER_EV_STATE_IN"},
638 {SER_EV_STATE_OUT, "SER_EV_STATE_OUT"},
639 {SER_EV_L1_RESET, "SER_EV_L1_RESET"},
640 {SER_EV_DO_RECOVERY, "SER_EV_DO_RECOVERY m3"},
641 {SER_EV_MAC_RESET_DONE, "SER_EV_MAC_RESET_DONE m5"},
642 {SER_EV_L2_RESET, "SER_EV_L2_RESET"},
643 {SER_EV_L2_RECFG_DONE, "SER_EV_L2_RECFG_DONE"},
644 {SER_EV_L2_RECFG_TIMEOUT, "SER_EV_L2_RECFG_TIMEOUT"},
645 {SER_EV_M3_TIMEOUT, "SER_EV_M3_TIMEOUT"},
646 {SER_EV_FW_M5_TIMEOUT, "SER_EV_FW_M5_TIMEOUT"},
647 {SER_EV_L0_RESET, "SER_EV_L0_RESET"},
648 {SER_EV_MAXX, "SER_EV_MAX"}
651 static const struct state_ent ser_st_tbl[] = {
652 {SER_IDLE_ST, "SER_IDLE_ST", ser_idle_st_hdl},
653 {SER_RESET_TRX_ST, "SER_RESET_TRX_ST", ser_reset_trx_st_hdl},
654 {SER_DO_HCI_ST, "SER_DO_HCI_ST", ser_do_hci_st_hdl},
655 {SER_L2_RESET_ST, "SER_L2_RESET_ST", ser_l2_reset_st_hdl}
658 int rtw89_ser_init(struct rtw89_dev *rtwdev)
660 struct rtw89_ser *ser = &rtwdev->ser;
662 memset(ser, 0, sizeof(*ser));
663 INIT_LIST_HEAD(&ser->msg_q);
664 ser->state = SER_IDLE_ST;
665 ser->st_tbl = ser_st_tbl;
666 ser->ev_tbl = ser_ev_tbl;
668 bitmap_zero(ser->flags, RTW89_NUM_OF_SER_FLAGS);
669 spin_lock_init(&ser->msg_q_lock);
670 INIT_WORK(&ser->ser_hdl_work, rtw89_ser_hdl_work);
671 INIT_DELAYED_WORK(&ser->ser_alarm_work, rtw89_ser_alarm_work);
675 int rtw89_ser_deinit(struct rtw89_dev *rtwdev)
677 struct rtw89_ser *ser = (struct rtw89_ser *)&rtwdev->ser;
679 set_bit(RTW89_SER_DRV_STOP_RUN, ser->flags);
680 cancel_delayed_work_sync(&ser->ser_alarm_work);
681 cancel_work_sync(&ser->ser_hdl_work);
682 clear_bit(RTW89_SER_DRV_STOP_RUN, ser->flags);
686 void rtw89_ser_recfg_done(struct rtw89_dev *rtwdev)
688 ser_send_msg(&rtwdev->ser, SER_EV_L2_RECFG_DONE);
691 int rtw89_ser_notify(struct rtw89_dev *rtwdev, u32 err)
693 u8 event = SER_EV_NONE;
695 rtw89_info(rtwdev, "SER catches error: 0x%x\n", err);
698 case MAC_AX_ERR_L1_ERR_DMAC:
699 case MAC_AX_ERR_L0_PROMOTE_TO_L1:
700 event = SER_EV_L1_RESET; /* M1 */
702 case MAC_AX_ERR_L1_RESET_DISABLE_DMAC_DONE:
703 event = SER_EV_DO_RECOVERY; /* M3 */
705 case MAC_AX_ERR_L1_RESET_RECOVERY_DONE:
706 event = SER_EV_MAC_RESET_DONE; /* M5 */
708 case MAC_AX_ERR_L0_ERR_CMAC0:
709 case MAC_AX_ERR_L0_ERR_CMAC1:
710 case MAC_AX_ERR_L0_RESET_DONE:
711 event = SER_EV_L0_RESET;
714 if (err == MAC_AX_ERR_L1_PROMOTE_TO_L2 ||
715 (err >= MAC_AX_ERR_L2_ERR_AH_DMA &&
716 err <= MAC_AX_GET_ERR_MAX))
717 event = SER_EV_L2_RESET;
721 if (event == SER_EV_NONE) {
722 rtw89_warn(rtwdev, "SER cannot recognize error: 0x%x\n", err);
726 ser_send_msg(&rtwdev->ser, event);
729 EXPORT_SYMBOL(rtw89_ser_notify);