1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* Copyright (C) 2016 Freescale Semiconductor, Inc.
* Copyright 2017 NXP
*
* SPDX-License-Identifier: GPL-2.0+
*/
/*!
* Header file containing the public API for the System Controller (SC)
* One Time Programmable (OTP) function.
*
* @addtogroup OTP_SVC (SVC) One Time Programmable Service
*
* Module for the One Time Programmable (OTP) service.
*
* @{
*/
#ifndef _SC_OTP_API_H
#define _SC_OTP_API_H
/* Includes */
#include <asm/imx-common/sci/types.h>
/* Defines */
/* Types */
/*!
* This type is used to declare OTP values in word lengths.
*/
typedef uint32_t sc_otp_word_t;
/*!
* This type is used to declare OTP offset values (of OTP word lengths).
*/
typedef uint8_t sc_otp_offset_t;
/* Functions */
/*!
* This function reads the OTP value.
*
* @param[in] ipc IPC handle
* @param[in] offset offset into OTP region
* @param[out] data data to read from the OTP
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_UNAVAILABLE if caller's partition has no OTP resources,
* - SC_ERR_PARM if arguments out of range or invalid,
* - SC_ERR_NOACCESS No read allowed
*/
sc_err_t sc_otp_read(sc_ipc_t ipc, sc_otp_word_t *data,
sc_otp_offset_t offset);
/*!
* This function writes the OTP value.
*
* @param[in] ipc IPC handle
* @param[in] offset offset into OTP region
* @param[in] data data to write to the OTP
* @param[in] bitmask mask bits to program
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_UNAVAILABLE if caller's partition has no OTP resources,
* - SC_ERR_PARM if arguments out of range or invalid,
* - SC_ERR_NOACCESS No write allowed
*/
sc_err_t sc_otp_write(sc_ipc_t ipc, sc_otp_word_t data,
sc_otp_offset_t offset, sc_otp_word_t bitmask);
/*!
* This function allows the owner of a partition to set and lock access
* permissions. These permissions are carried forward if the OTP is
* reassigned
*
* @param[in] ipc IPC handle
* @param[in] offset OTP word to access
* @param[in] readen allows read access
* @param[in] writeen allows write access
* @param[in] lock no further changes to permissions during
* power cycle is allowed
*
* @return Returns an error code (SC_ERR_NONE = success).
*
* Return errors:
* - SC_ERR_UNAVAILABLE if caller's partition has no OTP resources,
* - SC_ERR_LOCKED if partition is already locked
*
* Assigns some part of the OTP resource owned by the caller's partition
* to another partition.
*/
sc_err_t sc_otp_set_permissions(sc_ipc_t ipc, sc_otp_offset_t offset,
bool readen, bool writeen, bool lock);
#endif /* _SC_OTP_API_H */
/**@}*/
|
