1f0553ca9SKalle Valo /* SPDX-License-Identifier: ISC */ 25e3dd157SKalle Valo /* 35e3dd157SKalle Valo * Copyright (c) 2005-2011 Atheros Communications Inc. 48b1083d6SKalle Valo * Copyright (c) 2011-2015,2017 Qualcomm Atheros, Inc. 55e3dd157SKalle Valo */ 65e3dd157SKalle Valo 75e3dd157SKalle Valo #ifndef _BMI_H_ 85e3dd157SKalle Valo #define _BMI_H_ 95e3dd157SKalle Valo 105e3dd157SKalle Valo #include "core.h" 115e3dd157SKalle Valo 125e3dd157SKalle Valo /* 135e3dd157SKalle Valo * Bootloader Messaging Interface (BMI) 145e3dd157SKalle Valo * 155e3dd157SKalle Valo * BMI is a very simple messaging interface used during initialization 165e3dd157SKalle Valo * to read memory, write memory, execute code, and to define an 175e3dd157SKalle Valo * application entry PC. 185e3dd157SKalle Valo * 195e3dd157SKalle Valo * It is used to download an application to QCA988x, to provide 205e3dd157SKalle Valo * patches to code that is already resident on QCA988x, and generally 215e3dd157SKalle Valo * to examine and modify state. The Host has an opportunity to use 225e3dd157SKalle Valo * BMI only once during bootup. Once the Host issues a BMI_DONE 235e3dd157SKalle Valo * command, this opportunity ends. 245e3dd157SKalle Valo * 255e3dd157SKalle Valo * The Host writes BMI requests to mailbox0, and reads BMI responses 265e3dd157SKalle Valo * from mailbox0. BMI requests all begin with a command 275e3dd157SKalle Valo * (see below for specific commands), and are followed by 285e3dd157SKalle Valo * command-specific data. 295e3dd157SKalle Valo * 305e3dd157SKalle Valo * Flow control: 315e3dd157SKalle Valo * The Host can only issue a command once the Target gives it a 325e3dd157SKalle Valo * "BMI Command Credit", using AR8K Counter #4. As soon as the 335e3dd157SKalle Valo * Target has completed a command, it issues another BMI Command 345e3dd157SKalle Valo * Credit (so the Host can issue the next command). 355e3dd157SKalle Valo * 365e3dd157SKalle Valo * BMI handles all required Target-side cache flushing. 375e3dd157SKalle Valo */ 385e3dd157SKalle Valo 395e3dd157SKalle Valo /* Maximum data size used for BMI transfers */ 405e3dd157SKalle Valo #define BMI_MAX_DATA_SIZE 256 415e3dd157SKalle Valo 425e3dd157SKalle Valo /* len = cmd + addr + length */ 435e3dd157SKalle Valo #define BMI_MAX_CMDBUF_SIZE (BMI_MAX_DATA_SIZE + \ 445e3dd157SKalle Valo sizeof(u32) + \ 455e3dd157SKalle Valo sizeof(u32) + \ 465e3dd157SKalle Valo sizeof(u32)) 475e3dd157SKalle Valo 48d58f466aSWen Gong /* Maximum data size used for large BMI transfers */ 49d58f466aSWen Gong #define BMI_MAX_LARGE_DATA_SIZE 2048 50d58f466aSWen Gong 51d58f466aSWen Gong /* len = cmd + addr + length */ 52d58f466aSWen Gong #define BMI_MAX_LARGE_CMDBUF_SIZE (BMI_MAX_LARGE_DATA_SIZE + \ 53d58f466aSWen Gong sizeof(u32) + \ 54d58f466aSWen Gong sizeof(u32) + \ 55d58f466aSWen Gong sizeof(u32)) 56d58f466aSWen Gong 575e3dd157SKalle Valo /* BMI Commands */ 585e3dd157SKalle Valo 595e3dd157SKalle Valo enum bmi_cmd_id { 605e3dd157SKalle Valo BMI_NO_COMMAND = 0, 615e3dd157SKalle Valo BMI_DONE = 1, 625e3dd157SKalle Valo BMI_READ_MEMORY = 2, 635e3dd157SKalle Valo BMI_WRITE_MEMORY = 3, 645e3dd157SKalle Valo BMI_EXECUTE = 4, 655e3dd157SKalle Valo BMI_SET_APP_START = 5, 665e3dd157SKalle Valo BMI_READ_SOC_REGISTER = 6, 675e3dd157SKalle Valo BMI_READ_SOC_WORD = 6, 685e3dd157SKalle Valo BMI_WRITE_SOC_REGISTER = 7, 695e3dd157SKalle Valo BMI_WRITE_SOC_WORD = 7, 705e3dd157SKalle Valo BMI_GET_TARGET_ID = 8, 715e3dd157SKalle Valo BMI_GET_TARGET_INFO = 8, 725e3dd157SKalle Valo BMI_ROMPATCH_INSTALL = 9, 735e3dd157SKalle Valo BMI_ROMPATCH_UNINSTALL = 10, 745e3dd157SKalle Valo BMI_ROMPATCH_ACTIVATE = 11, 755e3dd157SKalle Valo BMI_ROMPATCH_DEACTIVATE = 12, 765e3dd157SKalle Valo BMI_LZ_STREAM_START = 13, /* should be followed by LZ_DATA */ 775e3dd157SKalle Valo BMI_LZ_DATA = 14, 785e3dd157SKalle Valo BMI_NVRAM_PROCESS = 15, 795e3dd157SKalle Valo }; 805e3dd157SKalle Valo 815e3dd157SKalle Valo #define BMI_NVRAM_SEG_NAME_SZ 16 825e3dd157SKalle Valo 83db0984e5SManikanta Pubbisetty #define BMI_PARAM_GET_EEPROM_BOARD_ID 0x10 84a9f5f287SAnilkumar Kolli #define BMI_PARAM_GET_FLASH_BOARD_ID 0x8000 85a9f5f287SAnilkumar Kolli #define BMI_PARAM_FLASH_SECTION_ALL 0x10000 86db0984e5SManikanta Pubbisetty 8731324d17SSathishkumar Muruganandam /* Dual-band Extended Board ID */ 8831324d17SSathishkumar Muruganandam #define BMI_PARAM_GET_EXT_BOARD_ID 0x40000 8931324d17SSathishkumar Muruganandam #define ATH10K_BMI_EXT_BOARD_ID_SUPPORT 0x40000 9031324d17SSathishkumar Muruganandam 91db0984e5SManikanta Pubbisetty #define ATH10K_BMI_BOARD_ID_FROM_OTP_MASK 0x7c00 92db0984e5SManikanta Pubbisetty #define ATH10K_BMI_BOARD_ID_FROM_OTP_LSB 10 93db0984e5SManikanta Pubbisetty 94db0984e5SManikanta Pubbisetty #define ATH10K_BMI_CHIP_ID_FROM_OTP_MASK 0x18000 95db0984e5SManikanta Pubbisetty #define ATH10K_BMI_CHIP_ID_FROM_OTP_LSB 15 96db0984e5SManikanta Pubbisetty 97db0984e5SManikanta Pubbisetty #define ATH10K_BMI_BOARD_ID_STATUS_MASK 0xff 9831324d17SSathishkumar Muruganandam #define ATH10K_BMI_EBOARD_ID_STATUS_MASK 0xff 99db0984e5SManikanta Pubbisetty 1005e3dd157SKalle Valo struct bmi_cmd { 1015e3dd157SKalle Valo __le32 id; /* enum bmi_cmd_id */ 1025e3dd157SKalle Valo union { 1035e3dd157SKalle Valo struct { 1045e3dd157SKalle Valo } done; 1055e3dd157SKalle Valo struct { 1065e3dd157SKalle Valo __le32 addr; 1075e3dd157SKalle Valo __le32 len; 1085e3dd157SKalle Valo } read_mem; 1095e3dd157SKalle Valo struct { 1105e3dd157SKalle Valo __le32 addr; 1115e3dd157SKalle Valo __le32 len; 112*47c66248SKees Cook u8 payload[]; 1135e3dd157SKalle Valo } write_mem; 1145e3dd157SKalle Valo struct { 1155e3dd157SKalle Valo __le32 addr; 1165e3dd157SKalle Valo __le32 param; 1175e3dd157SKalle Valo } execute; 1185e3dd157SKalle Valo struct { 1195e3dd157SKalle Valo __le32 addr; 1205e3dd157SKalle Valo } set_app_start; 1215e3dd157SKalle Valo struct { 1225e3dd157SKalle Valo __le32 addr; 1235e3dd157SKalle Valo } read_soc_reg; 1245e3dd157SKalle Valo struct { 1255e3dd157SKalle Valo __le32 addr; 1265e3dd157SKalle Valo __le32 value; 1275e3dd157SKalle Valo } write_soc_reg; 1285e3dd157SKalle Valo struct { 1295e3dd157SKalle Valo } get_target_info; 1305e3dd157SKalle Valo struct { 1315e3dd157SKalle Valo __le32 rom_addr; 1325e3dd157SKalle Valo __le32 ram_addr; /* or value */ 1335e3dd157SKalle Valo __le32 size; 1345e3dd157SKalle Valo __le32 activate; /* 0=install, but dont activate */ 1355e3dd157SKalle Valo } rompatch_install; 1365e3dd157SKalle Valo struct { 1375e3dd157SKalle Valo __le32 patch_id; 1385e3dd157SKalle Valo } rompatch_uninstall; 1395e3dd157SKalle Valo struct { 1405e3dd157SKalle Valo __le32 count; 141*47c66248SKees Cook __le32 patch_ids[]; /* length of @count */ 1425e3dd157SKalle Valo } rompatch_activate; 1435e3dd157SKalle Valo struct { 1445e3dd157SKalle Valo __le32 count; 145*47c66248SKees Cook __le32 patch_ids[]; /* length of @count */ 1465e3dd157SKalle Valo } rompatch_deactivate; 1475e3dd157SKalle Valo struct { 1485e3dd157SKalle Valo __le32 addr; 1495e3dd157SKalle Valo } lz_start; 1505e3dd157SKalle Valo struct { 1515e3dd157SKalle Valo __le32 len; /* max BMI_MAX_DATA_SIZE */ 152*47c66248SKees Cook u8 payload[]; /* length of @len */ 1535e3dd157SKalle Valo } lz_data; 1545e3dd157SKalle Valo struct { 1555e3dd157SKalle Valo u8 name[BMI_NVRAM_SEG_NAME_SZ]; 1565e3dd157SKalle Valo } nvram_process; 1575e3dd157SKalle Valo u8 payload[BMI_MAX_CMDBUF_SIZE]; 1585e3dd157SKalle Valo }; 1595e3dd157SKalle Valo } __packed; 1605e3dd157SKalle Valo 1615e3dd157SKalle Valo union bmi_resp { 1625e3dd157SKalle Valo struct { 163*47c66248SKees Cook DECLARE_FLEX_ARRAY(u8, payload); 1645e3dd157SKalle Valo } read_mem; 1655e3dd157SKalle Valo struct { 1665e3dd157SKalle Valo __le32 result; 1675e3dd157SKalle Valo } execute; 1685e3dd157SKalle Valo struct { 1695e3dd157SKalle Valo __le32 value; 1705e3dd157SKalle Valo } read_soc_reg; 1715e3dd157SKalle Valo struct { 1725e3dd157SKalle Valo __le32 len; 1735e3dd157SKalle Valo __le32 version; 1745e3dd157SKalle Valo __le32 type; 1755e3dd157SKalle Valo } get_target_info; 1765e3dd157SKalle Valo struct { 1775e3dd157SKalle Valo __le32 patch_id; 1785e3dd157SKalle Valo } rompatch_install; 1795e3dd157SKalle Valo struct { 1805e3dd157SKalle Valo __le32 patch_id; 1815e3dd157SKalle Valo } rompatch_uninstall; 1825e3dd157SKalle Valo struct { 1835e3dd157SKalle Valo /* 0 = nothing executed 18437ff1b0dSMarcin Rokicki * otherwise = NVRAM segment return value 18537ff1b0dSMarcin Rokicki */ 1865e3dd157SKalle Valo __le32 result; 1875e3dd157SKalle Valo } nvram_process; 1885e3dd157SKalle Valo u8 payload[BMI_MAX_CMDBUF_SIZE]; 1895e3dd157SKalle Valo } __packed; 1905e3dd157SKalle Valo 1915e3dd157SKalle Valo struct bmi_target_info { 1925e3dd157SKalle Valo u32 version; 1935e3dd157SKalle Valo u32 type; 1945e3dd157SKalle Valo }; 1955e3dd157SKalle Valo 19639501ea6SCarl Huang struct bmi_segmented_file_header { 19739501ea6SCarl Huang __le32 magic_num; 19839501ea6SCarl Huang __le32 file_flags; 19939501ea6SCarl Huang u8 data[]; 20039501ea6SCarl Huang }; 20139501ea6SCarl Huang 20239501ea6SCarl Huang struct bmi_segmented_metadata { 20339501ea6SCarl Huang __le32 addr; 20439501ea6SCarl Huang __le32 length; 20539501ea6SCarl Huang u8 data[]; 20639501ea6SCarl Huang }; 20739501ea6SCarl Huang 20839501ea6SCarl Huang #define BMI_SGMTFILE_MAGIC_NUM 0x544d4753 /* "SGMT" */ 20939501ea6SCarl Huang #define BMI_SGMTFILE_FLAG_COMPRESS 1 21039501ea6SCarl Huang 21139501ea6SCarl Huang /* Special values for bmi_segmented_metadata.length (all have high bit set) */ 21239501ea6SCarl Huang 21339501ea6SCarl Huang /* end of segmented data */ 21439501ea6SCarl Huang #define BMI_SGMTFILE_DONE 0xffffffff 21539501ea6SCarl Huang 21639501ea6SCarl Huang /* Board Data segment */ 21739501ea6SCarl Huang #define BMI_SGMTFILE_BDDATA 0xfffffffe 21839501ea6SCarl Huang 21939501ea6SCarl Huang /* set beginning address */ 22039501ea6SCarl Huang #define BMI_SGMTFILE_BEGINADDR 0xfffffffd 22139501ea6SCarl Huang 22239501ea6SCarl Huang /* immediate function execution */ 22339501ea6SCarl Huang #define BMI_SGMTFILE_EXEC 0xfffffffc 22439501ea6SCarl Huang 22513c3b26aSBen Greear /* in jiffies */ 22613c3b26aSBen Greear #define BMI_COMMUNICATION_TIMEOUT_HZ (3 * HZ) 2275e3dd157SKalle Valo 2285e3dd157SKalle Valo #define BMI_CE_NUM_TO_TARG 0 2295e3dd157SKalle Valo #define BMI_CE_NUM_TO_HOST 1 2305e3dd157SKalle Valo 23164d151d4SMichal Kazior void ath10k_bmi_start(struct ath10k *ar); 2325e3dd157SKalle Valo int ath10k_bmi_done(struct ath10k *ar); 2335e3dd157SKalle Valo int ath10k_bmi_get_target_info(struct ath10k *ar, 2345e3dd157SKalle Valo struct bmi_target_info *target_info); 23534dd398aSErik Stromdahl int ath10k_bmi_get_target_info_sdio(struct ath10k *ar, 23634dd398aSErik Stromdahl struct bmi_target_info *target_info); 2375e3dd157SKalle Valo int ath10k_bmi_read_memory(struct ath10k *ar, u32 address, 2385e3dd157SKalle Valo void *buffer, u32 length); 2395e3dd157SKalle Valo int ath10k_bmi_write_memory(struct ath10k *ar, u32 address, 2405e3dd157SKalle Valo const void *buffer, u32 length); 2415e3dd157SKalle Valo 2425e3dd157SKalle Valo #define ath10k_bmi_read32(ar, item, val) \ 2435e3dd157SKalle Valo ({ \ 2445e3dd157SKalle Valo int ret; \ 2455e3dd157SKalle Valo u32 addr; \ 2465e3dd157SKalle Valo __le32 tmp; \ 2475e3dd157SKalle Valo \ 2485e3dd157SKalle Valo addr = host_interest_item_address(HI_ITEM(item)); \ 2495e3dd157SKalle Valo ret = ath10k_bmi_read_memory(ar, addr, (u8 *)&tmp, 4); \ 250afe5b7b4SFrederic Danis if (!ret) \ 2515e3dd157SKalle Valo *val = __le32_to_cpu(tmp); \ 2525e3dd157SKalle Valo ret; \ 2535e3dd157SKalle Valo }) 2545e3dd157SKalle Valo 2555e3dd157SKalle Valo #define ath10k_bmi_write32(ar, item, val) \ 2565e3dd157SKalle Valo ({ \ 2575e3dd157SKalle Valo int ret; \ 2585e3dd157SKalle Valo u32 address; \ 2595e3dd157SKalle Valo __le32 v = __cpu_to_le32(val); \ 2605e3dd157SKalle Valo \ 2615e3dd157SKalle Valo address = host_interest_item_address(HI_ITEM(item)); \ 2625e3dd157SKalle Valo ret = ath10k_bmi_write_memory(ar, address, \ 2635e3dd157SKalle Valo (u8 *)&v, sizeof(v)); \ 2645e3dd157SKalle Valo ret; \ 2655e3dd157SKalle Valo }) 2665e3dd157SKalle Valo 267d6d4a58dSKalle Valo int ath10k_bmi_execute(struct ath10k *ar, u32 address, u32 param, u32 *result); 2685e3dd157SKalle Valo int ath10k_bmi_lz_stream_start(struct ath10k *ar, u32 address); 2695e3dd157SKalle Valo int ath10k_bmi_lz_data(struct ath10k *ar, const void *buffer, u32 length); 270d58f466aSWen Gong 2715e3dd157SKalle Valo int ath10k_bmi_fast_download(struct ath10k *ar, u32 address, 2725e3dd157SKalle Valo const void *buffer, u32 length); 273583a6629SRyan Hsu int ath10k_bmi_read_soc_reg(struct ath10k *ar, u32 address, u32 *reg_val); 274583a6629SRyan Hsu int ath10k_bmi_write_soc_reg(struct ath10k *ar, u32 address, u32 reg_val); 27539501ea6SCarl Huang int ath10k_bmi_set_start(struct ath10k *ar, u32 address); 27639501ea6SCarl Huang 2775e3dd157SKalle Valo #endif /* _BMI_H_ */ 278