1 // Copyright 2019 Espressif Systems (Shanghai) PTE LTD
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 #define COUNT_EFUSE_REG_PER_BLOCK 8      /* The number of registers per block. */
22 
23 #define ESP_EFUSE_SECURE_VERSION_NUM_BLOCK EFUSE_BLK3
24 
25 #define ESP_EFUSE_FIELD_CORRESPONDS_CODING_SCHEME(blk, max_num_bit)                                   \
26 	esp_efuse_coding_scheme_t scheme = esp_efuse_get_coding_scheme(blk);                              \
27     if ((scheme == EFUSE_CODING_SCHEME_3_4    && max_num_bit > 192) ||                                \
28         (scheme == EFUSE_CODING_SCHEME_REPEAT && max_num_bit > 128)) {                                \
29     	return false;                                                                                 \
30     }
31 
32 /* @brief Encode one or more sets of 6 byte sequences into
33  * 8 bytes suitable for 3/4 Coding Scheme.
34  *
35  * This function is only useful if the CODING_SCHEME efuse
36  * is set to value 1 for 3/4 Coding Scheme.
37  *
38  * @param[in] in_bytes Pointer to a sequence of bytes to encode for 3/4 Coding Scheme. Must have length in_bytes_len. After being written to hardware, these bytes will read back as little-endian words.
39  * @param[out] out_words Pointer to array of words suitable for writing to efuse write registers. Array must contain 2 words (8 bytes) for every 6 bytes in in_bytes_len. Can be a pointer to efuse write registers.
40  * @param in_bytes_len. Length of array pointed to by in_bytes, in bytes. Must be a multiple of 6.
41  *
42  * @return ESP_ERR_INVALID_ARG if either pointer is null or in_bytes_len is not a multiple of 6. ESP_OK otherwise.
43  */
44 esp_err_t esp_efuse_utility_apply_34_encoding(const uint8_t *in_bytes, uint32_t *out_words, size_t in_bytes_len);
45 
46 #ifdef __cplusplus
47 }
48 #endif
49