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