xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/ath/wil6210/boot_loader.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: ISC */
2*4882a593Smuzhiyun /* Copyright (c) 2015 Qualcomm Atheros, Inc.
3*4882a593Smuzhiyun  * Copyright (c) 2018, The Linux Foundation. All rights reserved.
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun /* This file contains the definitions for the boot loader
7*4882a593Smuzhiyun  * for the Qualcomm "Sparrow" 60 Gigabit wireless solution.
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun #ifndef BOOT_LOADER_EXPORT_H_
10*4882a593Smuzhiyun #define BOOT_LOADER_EXPORT_H_
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun struct bl_dedicated_registers_v1 {
13*4882a593Smuzhiyun 	__le32	boot_loader_ready;		/* 0x880A3C driver will poll
14*4882a593Smuzhiyun 						 * this Dword until BL will
15*4882a593Smuzhiyun 						 * set it to 1 (initial value
16*4882a593Smuzhiyun 						 * should be 0)
17*4882a593Smuzhiyun 						 */
18*4882a593Smuzhiyun 	__le32	boot_loader_struct_version;	/* 0x880A40 BL struct ver. */
19*4882a593Smuzhiyun 	__le16	rf_type;			/* 0x880A44 connected RF ID */
20*4882a593Smuzhiyun 	__le16	rf_status;			/* 0x880A46 RF status,
21*4882a593Smuzhiyun 						 * 0 is OK else error
22*4882a593Smuzhiyun 						 */
23*4882a593Smuzhiyun 	__le32	baseband_type;			/* 0x880A48 board type ID */
24*4882a593Smuzhiyun 	u8	mac_address[6];			/* 0x880A4c BL mac address */
25*4882a593Smuzhiyun 	u8	bl_version_major;		/* 0x880A52 BL ver. major */
26*4882a593Smuzhiyun 	u8	bl_version_minor;		/* 0x880A53 BL ver. minor */
27*4882a593Smuzhiyun 	__le16	bl_version_subminor;		/* 0x880A54 BL ver. subminor */
28*4882a593Smuzhiyun 	__le16	bl_version_build;		/* 0x880A56 BL ver. build */
29*4882a593Smuzhiyun 	/* valid only for version 2 and above */
30*4882a593Smuzhiyun 	__le32  bl_assert_code;         /* 0x880A58 BL Assert code */
31*4882a593Smuzhiyun 	__le32  bl_assert_blink;        /* 0x880A5C BL Assert Branch */
32*4882a593Smuzhiyun 	__le32  bl_shutdown_handshake;  /* 0x880A60 BL cleaner shutdown */
33*4882a593Smuzhiyun 	__le32  bl_reserved[21];        /* 0x880A64 - 0x880AB4 */
34*4882a593Smuzhiyun 	__le32  bl_magic_number;        /* 0x880AB8 BL Magic number */
35*4882a593Smuzhiyun } __packed;
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* the following struct is the version 0 struct */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun struct bl_dedicated_registers_v0 {
40*4882a593Smuzhiyun 	__le32	boot_loader_ready;		/* 0x880A3C driver will poll
41*4882a593Smuzhiyun 						 * this Dword until BL will
42*4882a593Smuzhiyun 						 * set it to 1 (initial value
43*4882a593Smuzhiyun 						 * should be 0)
44*4882a593Smuzhiyun 						 */
45*4882a593Smuzhiyun #define BL_READY (1)	/* ready indication */
46*4882a593Smuzhiyun 	__le32	boot_loader_struct_version;	/* 0x880A40 BL struct ver. */
47*4882a593Smuzhiyun 	__le32	rf_type;			/* 0x880A44 connected RF ID */
48*4882a593Smuzhiyun 	__le32	baseband_type;			/* 0x880A48 board type ID */
49*4882a593Smuzhiyun 	u8	mac_address[6];			/* 0x880A4c BL mac address */
50*4882a593Smuzhiyun } __packed;
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun /* bits for bl_shutdown_handshake */
53*4882a593Smuzhiyun #define BL_SHUTDOWN_HS_GRTD		BIT(0)
54*4882a593Smuzhiyun #define BL_SHUTDOWN_HS_RTD		BIT(1)
55*4882a593Smuzhiyun #define BL_SHUTDOWN_HS_PROT_VER(x) WIL_GET_BITS(x, 28, 31)
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #endif /* BOOT_LOADER_EXPORT_H_ */
58