Kinetis Bootloader  2.0.0
Common bootloader for Kinetis devices
fsl_otfad_driver.h
1 /*
2  * Copyright (c) 2014, Freescale Semiconductor, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * o Redistributions of source code must retain the above copyright notice, this list
9  * of conditions and the following disclaimer.
10  *
11  * o Redistributions in binary form must reproduce the above copyright notice, this
12  * list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from this
17  * software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef _fsl_otfad_h
32 #define _fsl_oftad_h
33 
34 #include "bootloader_common.h"
35 #include "otfad/hal/fsl_otfad_hal.h"
36 
39 
41 // Definitions
43 
46 {
47  kStatus_OtfadSecurityViolation = MAKE_STATUS(kStatusGroup_OTFADDriver, 0),
48  kStatus_OtfadLogicallyDisabled = MAKE_STATUS(kStatusGroup_OTFADDriver, 1),
49  kStatus_OtfadInvalidKey = MAKE_STATUS(kStatusGroup_OTFADDriver, 2),
50  kStatus_OtfadInvalidKeyBlob = MAKE_STATUS(kStatusGroup_OTFADDriver, 3)
51 };
52 
57 typedef struct OtfadKek
58 {
59  uint32_t keyWord0;
60  uint32_t keyWord1;
61  uint32_t keyWord2;
62  uint32_t keyWord3;
63 } otfad_kek_t;
64 
66 // Prototypes
68 
69 #if defined(__cplusplus)
70 extern "C" {
71 #endif // __cplusplus
72 
86 status_t otfad_init(uint32_t instance, const uint8_t *keyBlobs, const otfad_kek_t *kek);
87 
88 #if defined(__cplusplus)
89 }
90 #endif // __cplusplus
91 
93 
94 #endif // _fsl_otfad.h_
95 
97 // EOF
uint32_t keyWord0
Word0: KEY[31:0][A03, A02, A01, A00].
Definition: fsl_otfad_driver.h:59
_otfad_driver_errors
OTFAD Driver status codes.
Definition: fsl_otfad_driver.h:45
uint32_t keyWord2
Word2: KEY[31:0][A11, A10, A09, A08].
Definition: fsl_otfad_driver.h:61
uint32_t keyWord3
Word3: KEY[31:0][A15, A14, A13, A12].
Definition: fsl_otfad_driver.h:62
uint32_t keyWord1
Word1: KEY[31:0][A07, A06, A05, A04].
Definition: fsl_otfad_driver.h:60
OTFAD driver status group number.
Definition: bootloader_common.h:158
int32_t status_t
Type used for all status and error return values.
Definition: fsl_common.h:121
Format of OTFAD key wrap key (KEK).
Definition: fsl_otfad_driver.h:57
status_t otfad_init(uint32_t instance, const uint8_t *keyBlobs, const otfad_kek_t *kek)
Initialize.
Definition: fsl_otfad_driver.c:157