xref: /OK3568_Linux_fs/external/rkwifibt/drivers/bcmdhd/include/dngl_rtlv.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Interface definitions for reversed TLVs
3  *
4  * Copyright (C) 2020, Broadcom.
5  *
6  *      Unless you and Broadcom execute a separate written software license
7  * agreement governing use of this software, this software is licensed to you
8  * under the terms of the GNU General Public License version 2 (the "GPL"),
9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10  * following added to such license:
11  *
12  *      As a special exception, the copyright holders of this software give you
13  * permission to link this software with independent modules, and to copy and
14  * distribute the resulting executable under terms of your choice, provided that
15  * you also meet, for each linked independent module, the terms and conditions of
16  * the license of that module.  An independent module is a module which is not
17  * derived from this software.  The special exception does not apply to any
18  * modifications of the software.
19  *
20  *
21  * <<Broadcom-WL-IPTag/Dual:>>
22  */
23 
24 #ifndef _dngl_rtlv_h_
25 #define _dngl_rtlv_h_
26 
27 #include <typedefs.h>
28 
29 /* Types of reverse TLVs downloaded to the top of dongle RAM.
30  * A reverse TLV consists of:
31  *     data <variable length>
32  *     len  <4 bytes>
33  *     type <4 bytes>
34  */
35 enum {
36 	DNGL_RTLV_TYPE_NONE = 0,
37 	/* replaces bcmrand.h BCM_NVRAM_RNG_SIGNATURE */
38 	DNGL_RTLV_TYPE_RNG_SIGNATURE =		0xFEEDC0DEu,	/* RNG random data */
39 	DNGL_RTLV_TYPE_FW_SIGNATURE =		0xFEEDFE51,	/* FW signature */
40 	DNGL_RTLV_TYPE_NVRAM_SIGNATURE =	0xFEEDFE52,	/* NVRAM signature */
41 	DNGL_RTLV_TYPE_FWSIGN_MEM_MAP =		0xFEEDFE53,	/* FW signing memory map */
42 	DNGL_RTLV_TYPE_FWSIGN_STATUS =		0xFEEDFE54,	/* signature verification status */
43 	DNGL_RTLV_TYPE_END_MARKER =		0xFEED0E2D,	/* end of rTLVs marker */
44 };
45 typedef uint32	dngl_rtlv_type_t;
46 typedef uint32	dngl_rtlv_len_t;
47 
48 /* Search for a reversed TLV with the given type, starting at the given address */
49 int dngl_rtlv_find(const uint8 *rtlv_ptr, const uint8 *addr_limit, dngl_rtlv_type_t type,
50 	dngl_rtlv_len_t *out_len, const uint8 **out_data);
51 
52 /* Search for a reversed TLV with the given type, starting at the top of RAM */
53 int dngl_rtlv_find_from_ramtop(dngl_rtlv_type_t type, dngl_rtlv_len_t *out_len,
54 	const uint8 **out_data);
55 
56 /* Search for the end of the reversed TLVs at the top of RAM to return the next RAM address */
57 const uint8* dngl_rtlv_skipall(void);
58 
59 #ifdef RTLV_DEBUG
60 void dbg_log_rtlv(const char* str, const void* p1, const void* p2, const void *p3,
61 	const void* p4, const void *p5);
62 #else /* RTLV_DEBUG */
63 #define dbg_log_rtlv(str, p1, p2, p3, p4, p5)
64 #endif /* RTLV_DEBUG */
65 
66 #endif /* _dngl_rtlv_h_ */
67