aboutsummaryrefslogtreecommitdiff
path: root/KSDK_1.2.0/platform/drivers/inc/fsl_mpu_driver.h
blob: 78b61289f572da8b230f5d8fb18cc7769dcdb3c0 (plain)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*
 * Copyright (c) 2013 - 2015, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice, this
 *   list of conditions and the following disclaimer in the documentation and/or
 *   other materials provided with the distribution.
 *
 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef __FSL_MPU_DRIVER_H__
#define __FSL_MPU_DRIVER_H__

#include <assert.h>
#include <stdint.h>
#include <stdbool.h>
#include "fsl_mpu_hal.h"
#if FSL_FEATURE_SOC_MPU_COUNT

/*! 
 * @addtogroup mpu_driver
 * @{
 */

/*******************************************************************************
 * Definitions
 *******************************************************************************/

/*! @brief Table of base addresses for MPU instances. */
extern MPU_Type * const g_mpuBase[];

 /*! @brief Table to save MPU IRQ enumeration numbers defined in the CMSIS header file. */
extern const IRQn_Type g_mpuIrqId[MPU_INSTANCE_COUNT];

/*! 
 * @brief Data The section describes the programming interface of the for MPU region initialization
 *
 * This structure is used when calling the MPU_DRV_Init function.
 * 
 */
typedef struct MpuUserConfig{
    mpu_region_config_t  regionConfig;  /*!< region access permission      */
    struct MpuUserConfig *next;         /*!< pointer to the next structure */
}mpu_user_config_t;

/*!
 * @brief MPU driver user call back function.
 *
 * The contents of this structure provides a callback function.
 */

/*******************************************************************************
 * API
 *******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif

/*! 
 * @name MPU Driver
 * @{
 */

  
/*!
 * @brief Initializes the MPU driver.
 *
 * @param instance The MPU peripheral instance number.
 * @param userConfigPtr The pointer to the MPU user configure structure, see #mpu_user_config_t.
 * @param userStatePtr The pointer of run time structure.
 * @return kStatus_MPU_Success means success. Otherwise, means failure.
 */
 mpu_status_t MPU_DRV_Init(uint32_t instance, const mpu_user_config_t *userConfigPtr);

/*!
 * @brief De-initializes the MPU region.
 *
 * @param instance The MPU peripheral instance number.  
 * @return kStatus_MPU_Success means success. Otherwise, means failure.
 */
void MPU_DRV_Deinit(uint32_t instance);

/*!
 * @brief Configures the MPU region.
 *
 * @param instance The MPU peripheral instance number.
 * @param regionConfigPtr The pointer to the MPU user configure structure, see #mpu_region_config_t.
 * @return kStatus_MPU_Success means success. Otherwise, means failure.
 */
mpu_status_t MPU_DRV_SetRegionConfig(uint32_t instance, const mpu_region_config_t *regionConfigPtr);

/*!
 * @brief Sets region start address.
 *
 * @param instance The MPU peripheral instance number.
 * @param regionNum The region number.
 * @param startAddr Region start address.
 * @param endAddr Region end address.
 */
void MPU_DRV_SetRegionAddr(uint32_t instance, mpu_region_num_t regionNum, uint32_t startAddr, uint32_t endAddr);

/*!
 * @brief Configures low master access permission.
 *
 * @param instance The MPU peripheral instance number.
 * @param regionNum The MPU region number.
 * @param masterNum The MPU master number.
 * @param accessRightsPtr A pointer to access permission structure.
 * @return kStatus_MPU_Success means success. Otherwise, means failure.
 */
mpu_status_t MPU_DRV_SetLowMasterAccessRights(uint32_t instance, mpu_region_num_t regionNum, mpu_master_t masterNum, const mpu_low_masters_access_rights_t *accessRightsPtr);

/*!
 * @brief Configures high master access permission.
 *
 * @param instance The MPU peripheral instance number.
 * @param regionNum The MPU region number.
 * @param masterNum The MPU master number.
 * @param accessRightsPtr A pointer to access permission structure.
 * @return kStatus_MPU_Success means success. Otherwise, means failure.
 */
mpu_status_t MPU_DRV_SetHighMasterAccessRights(uint32_t instance, mpu_region_num_t regionNum, mpu_master_t masterNum, const mpu_high_masters_access_rights_t *accessRightsPtr);

 /*!
 * @brief Sets the MPU region valid.
 *
 * @param instance The MPU peripheral instance number.
 * @param regionNum MPU region number.
 * @param enable Enables or disables region.
 */
void MPU_DRV_SetRegionValidCmd(uint32_t instance, mpu_region_num_t regionNum, bool enable);

 /*!
 * @brief Gets the MPU access error detail information.
 *
 * @param instance The MPU peripheral instance number.
 * @param errInfoArrayPtr A pointer to access error info structure.
 */
mpu_status_t MPU_DRV_GetDetailErrorAccessInfo(uint32_t instance,  mpu_access_err_info_t *errInfoArrayPtr);

/*@}*/

#if defined(__cplusplus)
}
#endif

/*! @}*/

#endif
#endif /* __FSL_MPU_H__*/
/*******************************************************************************
 * EOF
 *******************************************************************************/