1 /* SPDX-License-Identifier: ISC */
3 * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
11 #define ATH10K_FW_CRASH_DUMP_VERSION 1
14 * enum ath10k_fw_crash_dump_type - types of data in the dump file
15 * @ATH10K_FW_CRASH_DUMP_REGDUMP: Register crash dump in binary format
17 enum ath10k_fw_crash_dump_type
{
18 ATH10K_FW_CRASH_DUMP_REGISTERS
= 0,
19 ATH10K_FW_CRASH_DUMP_CE_DATA
= 1,
21 /* contains multiple struct ath10k_dump_ram_data_hdr */
22 ATH10K_FW_CRASH_DUMP_RAM_DATA
= 2,
24 ATH10K_FW_CRASH_DUMP_MAX
,
27 struct ath10k_tlv_dump_data
{
28 /* see ath10k_fw_crash_dump_type above */
34 /* pad to 32-bit boundaries as needed */
38 struct ath10k_dump_file_data
{
39 /* dump file information */
41 /* "ATH10K-FW-DUMP" */
46 /* file dump version */
49 /* some info we can get from ath10k struct that might help */
55 /* 0 for now, in place for later hardware */
58 __le32 target_version
;
59 __le32 fw_version_major
;
60 __le32 fw_version_minor
;
61 __le32 fw_version_release
;
62 __le32 fw_version_build
;
63 __le32 phy_capability
;
64 __le32 hw_min_tx_power
;
65 __le32 hw_max_tx_power
;
70 /* firmware version string */
71 char fw_ver
[ETHTOOL_FWVERS_LEN
];
73 /* Kernel related information */
75 /* time-of-day stamp */
78 /* time-of-day stamp, nano-seconds */
81 /* LINUX_VERSION_CODE */
82 __le32 kernel_ver_code
;
87 /* room for growth w/out changing binary format */
90 /* struct ath10k_tlv_dump_data + more */
94 struct ath10k_dump_ram_data_hdr
{
95 /* enum ath10k_mem_region_type */
100 /* length of payload data, not including this header */
106 /* magic number to fill the holes not copied due to sections in regions */
107 #define ATH10K_MAGIC_NOT_COPIED 0xAA
109 /* part of user space ABI */
110 enum ath10k_mem_region_type
{
111 ATH10K_MEM_REGION_TYPE_REG
= 1,
112 ATH10K_MEM_REGION_TYPE_DRAM
= 2,
113 ATH10K_MEM_REGION_TYPE_AXI
= 3,
114 ATH10K_MEM_REGION_TYPE_IRAM1
= 4,
115 ATH10K_MEM_REGION_TYPE_IRAM2
= 5,
116 ATH10K_MEM_REGION_TYPE_IOSRAM
= 6,
117 ATH10K_MEM_REGION_TYPE_IOREG
= 7,
120 /* Define a section of the region which should be copied. As not all parts
121 * of the memory is possible to copy, for example some of the registers can
122 * be like that, sections can be used to define what is safe to copy.
124 * To minimize the size of the array, the list must obey the format:
125 * '{start0,stop0},{start1,stop1},{start2,stop2}....' The values below must
126 * also obey to 'start0 < stop0 < start1 < stop1 < start2 < ...', otherwise
127 * we may encouter error in the dump processing.
129 struct ath10k_mem_section
{
134 /* One region of a memory layout. If the sections field is null entire
135 * region is copied. If sections is non-null only the areas specified in
136 * sections are copied and rest of the areas are filled with
137 * ATH10K_MAGIC_NOT_COPIED.
139 struct ath10k_mem_region
{
140 enum ath10k_mem_region_type type
;
147 const struct ath10k_mem_section
*sections
;
152 /* Contains the memory layout of a hardware version identified with the
153 * hardware id, split into regions.
155 struct ath10k_hw_mem_layout
{
160 const struct ath10k_mem_region
*regions
;
165 /* FIXME: where to put this? */
166 extern unsigned long ath10k_coredump_mask
;
168 #ifdef CONFIG_DEV_COREDUMP
170 int ath10k_coredump_submit(struct ath10k
*ar
);
171 struct ath10k_fw_crash_data
*ath10k_coredump_new(struct ath10k
*ar
);
172 int ath10k_coredump_create(struct ath10k
*ar
);
173 int ath10k_coredump_register(struct ath10k
*ar
);
174 void ath10k_coredump_unregister(struct ath10k
*ar
);
175 void ath10k_coredump_destroy(struct ath10k
*ar
);
177 const struct ath10k_hw_mem_layout
*ath10k_coredump_get_mem_layout(struct ath10k
*ar
);
179 #else /* CONFIG_DEV_COREDUMP */
181 static inline int ath10k_coredump_submit(struct ath10k
*ar
)
186 static inline struct ath10k_fw_crash_data
*ath10k_coredump_new(struct ath10k
*ar
)
191 static inline int ath10k_coredump_create(struct ath10k
*ar
)
196 static inline int ath10k_coredump_register(struct ath10k
*ar
)
201 static inline void ath10k_coredump_unregister(struct ath10k
*ar
)
205 static inline void ath10k_coredump_destroy(struct ath10k
*ar
)
209 static inline const struct ath10k_hw_mem_layout
*
210 ath10k_coredump_get_mem_layout(struct ath10k
*ar
)
215 #endif /* CONFIG_DEV_COREDUMP */
217 #endif /* _COREDUMP_H_ */