HPM SDK
HPMicro Software Development Kit
hpm_otp_table.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024 HPMicro
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  */
7 
8 
9 #ifndef HPM_OTP_TABLE_H
10 #define HPM_OTP_TABLE_H
11 
12 /* OTP WORD OFFSET */
13 #define OTP_TABLE_HARD_LOCK_OFFSET (0U)
14 #define OTP_TABLE_LIFECYCLE_B_OFFSET (1U)
15 #define OTP_TABLE_TCU_DISABLE_OFFSET (1U)
16 #define OTP_TABLE_DEBUG_DISABLE_OFFSET (1U)
17 #define OTP_TABLE_JTAG_DISABLE_OFFSET (1U)
18 #define OTP_TABLE_PUK_REVOKE_OFFSET (1U)
19 #define OTP_TABLE_LIFECYCLE_A_OFFSET (1U)
20 #define OTP_TABLE_MONO_EPOCH_OFFSET (2U)
21 #define OTP_TABLE_SW_VER_OFFSET (3U)
22 #define OTP_TABLE_DIE_TRACE_OFFSET (8U)
23 #define OTP_TABLE_DEBUG_KEY_OFFSET (12U)
24 #define OTP_TABLE_TSNS_BASE_OFFSET (21U)
25 #define OTP_TABLE_TSNS_SLOPE_OFFSET (21U)
26 #define OTP_TABLE_CHIP_ID_OFFSET (64U)
27 #define OTP_TABLE_MAC0_OFFSET (65U)
28 #define OTP_TABLE_MAC1_OFFSET (66U)
29 #define OTP_TABLE_USB_PID_OFFSET (68U)
30 #define OTP_TABLE_USB_VID_OFFSET (68U)
31 #define OTP_TABLE_PUBLIC_KEY_HASH_OFFSET (80U)
32 #define OTP_TABLE_UUID_OFFSET (88U)
33 #define OTP_TABLE_EXIP0_KEY_OFFSET (96U)
34 #define OTP_TABLE_EXIP1_KEY_OFFSET (104U)
35 #define OTP_TABLE_MASTER_KEY_OFFSET (112U)
36 
37 /* HARD_LOCK */
38 #define OTP_TABLE_HARD_LOCK_MASK (0xFFFFFFFFU)
39 #define OTP_TABLE_HARD_LOCK_SHIFT (0x0U)
40 #define OTP_TABLE_HARD_LOCK_SET(x) (((uint32_t)(x) << OTP_TABLE_HARD_LOCK_SHIFT) & OTP_TABLE_HARD_LOCK_MASK)
41 #define OTP_TABLE_HARD_LOCK_GET(x) (((uint32_t)(x) & OTP_TABLE_HARD_LOCK_MASK) >> OTP_TABLE_HARD_LOCK_SHIFT)
42 
43 /* LIFECYCLE_B */
44 #define OTP_TABLE_LIFECYCLE_B_MASK (0xF0000000U)
45 #define OTP_TABLE_LIFECYCLE_B_SHIFT (0x1CU)
46 #define OTP_TABLE_LIFECYCLE_B_SET(x) (((uint32_t)(x) << OTP_TABLE_LIFECYCLE_B_SHIFT) & OTP_TABLE_LIFECYCLE_B_MASK)
47 #define OTP_TABLE_LIFECYCLE_B_GET(x) (((uint32_t)(x) & OTP_TABLE_LIFECYCLE_B_MASK) >> OTP_TABLE_LIFECYCLE_B_SHIFT)
48 
49 /* TCU_DISABLE */
50 #define OTP_TABLE_TCU_DISABLE_MASK (0x80000U)
51 #define OTP_TABLE_TCU_DISABLE_SHIFT (0x13U)
52 #define OTP_TABLE_TCU_DISABLE_SET(x) (((uint32_t)(x) << OTP_TABLE_TCU_DISABLE_SHIFT) & OTP_TABLE_TCU_DISABLE_MASK)
53 #define OTP_TABLE_TCU_DISABLE_GET(x) (((uint32_t)(x) & OTP_TABLE_TCU_DISABLE_MASK) >> OTP_TABLE_TCU_DISABLE_SHIFT)
54 
55 /* DEBUG_DISABLE */
56 #define OTP_TABLE_DEBUG_DISABLE_MASK (0x20000U)
57 #define OTP_TABLE_DEBUG_DISABLE_SHIFT (0x11U)
58 #define OTP_TABLE_DEBUG_DISABLE_SET(x) (((uint32_t)(x) << OTP_TABLE_DEBUG_DISABLE_SHIFT) & OTP_TABLE_DEBUG_DISABLE_MASK)
59 #define OTP_TABLE_DEBUG_DISABLE_GET(x) (((uint32_t)(x) & OTP_TABLE_DEBUG_DISABLE_MASK) >> OTP_TABLE_DEBUG_DISABLE_SHIFT)
60 
61 /* JTAG_DISABLE */
62 #define OTP_TABLE_JTAG_DISABLE_MASK (0x10000U)
63 #define OTP_TABLE_JTAG_DISABLE_SHIFT (0x10U)
64 #define OTP_TABLE_JTAG_DISABLE_SET(x) (((uint32_t)(x) << OTP_TABLE_JTAG_DISABLE_SHIFT) & OTP_TABLE_JTAG_DISABLE_MASK)
65 #define OTP_TABLE_JTAG_DISABLE_GET(x) (((uint32_t)(x) & OTP_TABLE_JTAG_DISABLE_MASK) >> OTP_TABLE_JTAG_DISABLE_SHIFT)
66 
67 /* PUK_REVOKE */
68 #define OTP_TABLE_PUK_REVOKE_MASK (0xFF00U)
69 #define OTP_TABLE_PUK_REVOKE_SHIFT (0x8U)
70 #define OTP_TABLE_PUK_REVOKE_SET(x) (((uint32_t)(x) << OTP_TABLE_PUK_REVOKE_SHIFT) & OTP_TABLE_PUK_REVOKE_MASK)
71 #define OTP_TABLE_PUK_REVOKE_GET(x) (((uint32_t)(x) & OTP_TABLE_PUK_REVOKE_MASK) >> OTP_TABLE_PUK_REVOKE_SHIFT)
72 
73 /* LIFECYCLE_A */
74 #define OTP_TABLE_LIFECYCLE_A_MASK (0xFU)
75 #define OTP_TABLE_LIFECYCLE_A_SHIFT (0x0U)
76 #define OTP_TABLE_LIFECYCLE_A_SET(x) (((uint32_t)(x) << OTP_TABLE_LIFECYCLE_A_SHIFT) & OTP_TABLE_LIFECYCLE_A_MASK)
77 #define OTP_TABLE_LIFECYCLE_A_GET(x) (((uint32_t)(x) & OTP_TABLE_LIFECYCLE_A_MASK) >> OTP_TABLE_LIFECYCLE_A_SHIFT)
78 
79 /* MONO_EPOCH */
80 #define OTP_TABLE_MONO_EPOCH_MASK (0xFFFF0000U)
81 #define OTP_TABLE_MONO_EPOCH_SHIFT (0x10U)
82 #define OTP_TABLE_MONO_EPOCH_SET(x) (((uint32_t)(x) << OTP_TABLE_MONO_EPOCH_SHIFT) & OTP_TABLE_MONO_EPOCH_MASK)
83 #define OTP_TABLE_MONO_EPOCH_GET(x) (((uint32_t)(x) & OTP_TABLE_MONO_EPOCH_MASK) >> OTP_TABLE_MONO_EPOCH_SHIFT)
84 
85 /* SW_VER */
86 #define OTP_TABLE_SW_VER_MASK (0xFFFFFFFFU)
87 #define OTP_TABLE_SW_VER_SHIFT (0x0U)
88 #define OTP_TABLE_SW_VER_SET(x) (((uint32_t)(x) << OTP_TABLE_SW_VER_SHIFT) & OTP_TABLE_SW_VER_MASK)
89 #define OTP_TABLE_SW_VER_GET(x) (((uint32_t)(x) & OTP_TABLE_SW_VER_MASK) >> OTP_TABLE_SW_VER_SHIFT)
90 
91 /* DIE_TRACE */
92 #define OTP_TABLE_DIE_TRACE_SHIFT (0x0U)
93 #define OTP_TABLE_DIE_TRACE_BIT_LENGTH (0x80U)
94 
95 /* DEBUG_KEY */
96 #define OTP_TABLE_DEBUG_KEY_SHIFT (0x0U)
97 #define OTP_TABLE_DEBUG_KEY_BIT_LENGTH (0x80U)
98 
99 /* TSNS_BASE */
100 #define OTP_TABLE_TSNS_BASE_MASK (0xFFFFU)
101 #define OTP_TABLE_TSNS_BASE_SHIFT (0x0U)
102 #define OTP_TABLE_TSNS_BASE_SET(x) (((uint32_t)(x) << OTP_TABLE_TSNS_BASE_SHIFT) & OTP_TABLE_TSNS_BASE_MASK)
103 #define OTP_TABLE_TSNS_BASE_GET(x) (((uint32_t)(x) & OTP_TABLE_TSNS_BASE_MASK) >> OTP_TABLE_TSNS_BASE_SHIFT)
104 
105 /* TSNS_SLOPE */
106 #define OTP_TABLE_TSNS_SLOPE_MASK (0xFFFF0000U)
107 #define OTP_TABLE_TSNS_SLOPE_SHIFT (0x10U)
108 #define OTP_TABLE_TSNS_SLOPE_SET(x) (((uint32_t)(x) << OTP_TABLE_TSNS_SLOPE_SHIFT) & OTP_TABLE_TSNS_SLOPE_MASK)
109 #define OTP_TABLE_TSNS_SLOPE_GET(x) (((uint32_t)(x) & OTP_TABLE_TSNS_SLOPE_MASK) >> OTP_TABLE_TSNS_SLOPE_SHIFT)
110 
111 /* CHIP_ID */
112 #define OTP_TABLE_CHIP_ID_MASK (0xFFFFFFFFU)
113 #define OTP_TABLE_CHIP_ID_SHIFT (0x0U)
114 #define OTP_TABLE_CHIP_ID_SET(x) (((uint32_t)(x) << OTP_TABLE_CHIP_ID_SHIFT) & OTP_TABLE_CHIP_ID_MASK)
115 #define OTP_TABLE_CHIP_ID_GET(x) (((uint32_t)(x) & OTP_TABLE_CHIP_ID_MASK) >> OTP_TABLE_CHIP_ID_SHIFT)
116 
117 /* MAC0 */
118 #define OTP_TABLE_MAC0_SHIFT (0x0U)
119 #define OTP_TABLE_MAC0_BIT_LENGTH (0x30U)
120 
121 /* MAC1 */
122 #define OTP_TABLE_MAC1_SHIFT (0x10U)
123 #define OTP_TABLE_MAC1_BIT_LENGTH (0x30U)
124 
125 /* USB_PID */
126 #define OTP_TABLE_USB_PID_MASK (0xFFFFU)
127 #define OTP_TABLE_USB_PID_SHIFT (0x0U)
128 #define OTP_TABLE_USB_PID_SET(x) (((uint32_t)(x) << OTP_TABLE_USB_PID_SHIFT) & OTP_TABLE_USB_PID_MASK)
129 #define OTP_TABLE_USB_PID_GET(x) (((uint32_t)(x) & OTP_TABLE_USB_PID_MASK) >> OTP_TABLE_USB_PID_SHIFT)
130 
131 /* USB_VID */
132 #define OTP_TABLE_USB_VID_MASK (0xFFFF0000U)
133 #define OTP_TABLE_USB_VID_SHIFT (0x10U)
134 #define OTP_TABLE_USB_VID_SET(x) (((uint32_t)(x) << OTP_TABLE_USB_VID_SHIFT) & OTP_TABLE_USB_VID_MASK)
135 #define OTP_TABLE_USB_VID_GET(x) (((uint32_t)(x) & OTP_TABLE_USB_VID_MASK) >> OTP_TABLE_USB_VID_SHIFT)
136 
137 /* PUBLIC_KEY_HASH */
138 #define OTP_TABLE_PUBLIC_KEY_HASH_SHIFT (0x0U)
139 #define OTP_TABLE_PUBLIC_KEY_HASH_BIT_LENGTH (0x100U)
140 
141 /* UUID */
142 #define OTP_TABLE_UUID_SHIFT (0x0U)
143 #define OTP_TABLE_UUID_BIT_LENGTH (0x80U)
144 
145 /* EXIP0_KEY */
146 #define OTP_TABLE_EXIP0_KEY_SHIFT (0x0U)
147 #define OTP_TABLE_EXIP0_KEY_BIT_LENGTH (0x100U)
148 
149 /* EXIP1_KEY */
150 #define OTP_TABLE_EXIP1_KEY_SHIFT (0x0U)
151 #define OTP_TABLE_EXIP1_KEY_BIT_LENGTH (0x100U)
152 
153 /* MASTER_KEY */
154 #define OTP_TABLE_MASTER_KEY_SHIFT (0x0U)
155 #define OTP_TABLE_MASTER_KEY_BIT_LENGTH (0x100U)
156 
157 
158 #endif /* HPM_OTP_TABLE_H */