/* SPDX-License-Identifier: ISC */ /* * Copyright (c) 2005-2011 Atheros Communications Inc. * Copyright (c) 2011-2015,2017 Qualcomm Atheros, Inc. */ #ifndef _BMI_H_ #define _BMI_H_ #include "core.h" /* * Bootloader Messaging Interface (BMI) * * BMI is a very simple messaging interface used during initialization * to read memory, write memory, execute code, and to define an * application entry PC. * * It is used to download an application to QCA988x, to provide * patches to code that is already resident on QCA988x, and generally * to examine and modify state. The Host has an opportunity to use * BMI only once during bootup. Once the Host issues a BMI_DONE * command, this opportunity ends. * * The Host writes BMI requests to mailbox0, and reads BMI responses * from mailbox0. BMI requests all begin with a command * (see below for specific commands), and are followed by * command-specific data. * * Flow control: * The Host can only issue a command once the Target gives it a * "BMI Command Credit", using AR8K Counter #4. As soon as the * Target has completed a command, it issues another BMI Command * Credit (so the Host can issue the next command). * * BMI handles all required Target-side cache flushing. */ /* Maximum data size used for BMI transfers */ #define BMI_MAX_DATA_SIZE … /* len = cmd + addr + length */ #define BMI_MAX_CMDBUF_SIZE … /* Maximum data size used for large BMI transfers */ #define BMI_MAX_LARGE_DATA_SIZE … /* len = cmd + addr + length */ #define BMI_MAX_LARGE_CMDBUF_SIZE … /* BMI Commands */ enum bmi_cmd_id { … }; #define BMI_NVRAM_SEG_NAME_SZ … #define BMI_PARAM_GET_EEPROM_BOARD_ID … #define BMI_PARAM_GET_FLASH_BOARD_ID … #define BMI_PARAM_FLASH_SECTION_ALL … /* Dual-band Extended Board ID */ #define BMI_PARAM_GET_EXT_BOARD_ID … #define ATH10K_BMI_EXT_BOARD_ID_SUPPORT … #define ATH10K_BMI_BOARD_ID_FROM_OTP_MASK … #define ATH10K_BMI_BOARD_ID_FROM_OTP_LSB … #define ATH10K_BMI_CHIP_ID_FROM_OTP_MASK … #define ATH10K_BMI_CHIP_ID_FROM_OTP_LSB … #define ATH10K_BMI_BOARD_ID_STATUS_MASK … #define ATH10K_BMI_EBOARD_ID_STATUS_MASK … struct bmi_cmd { … } __packed; bmi_resp __packed; struct bmi_target_info { … }; struct bmi_segmented_file_header { … }; struct bmi_segmented_metadata { … }; #define BMI_SGMTFILE_MAGIC_NUM … #define BMI_SGMTFILE_FLAG_COMPRESS … /* Special values for bmi_segmented_metadata.length (all have high bit set) */ /* end of segmented data */ #define BMI_SGMTFILE_DONE … /* Board Data segment */ #define BMI_SGMTFILE_BDDATA … /* set beginning address */ #define BMI_SGMTFILE_BEGINADDR … /* immediate function execution */ #define BMI_SGMTFILE_EXEC … /* in jiffies */ #define BMI_COMMUNICATION_TIMEOUT_HZ … #define BMI_CE_NUM_TO_TARG … #define BMI_CE_NUM_TO_HOST … void ath10k_bmi_start(struct ath10k *ar); int ath10k_bmi_done(struct ath10k *ar); int ath10k_bmi_get_target_info(struct ath10k *ar, struct bmi_target_info *target_info); int ath10k_bmi_get_target_info_sdio(struct ath10k *ar, struct bmi_target_info *target_info); int ath10k_bmi_read_memory(struct ath10k *ar, u32 address, void *buffer, u32 length); int ath10k_bmi_write_memory(struct ath10k *ar, u32 address, const void *buffer, u32 length); #define ath10k_bmi_read32(ar, item, val) … #define ath10k_bmi_write32(ar, item, val) … int ath10k_bmi_execute(struct ath10k *ar, u32 address, u32 param, u32 *result); int ath10k_bmi_lz_stream_start(struct ath10k *ar, u32 address); int ath10k_bmi_lz_data(struct ath10k *ar, const void *buffer, u32 length); int ath10k_bmi_fast_download(struct ath10k *ar, u32 address, const void *buffer, u32 length); int ath10k_bmi_read_soc_reg(struct ath10k *ar, u32 address, u32 *reg_val); int ath10k_bmi_write_soc_reg(struct ath10k *ar, u32 address, u32 reg_val); int ath10k_bmi_set_start(struct ath10k *ar, u32 address); #endif /* _BMI_H_ */
Codebase Browser
linux