157 lines
5.0 KiB
C
157 lines
5.0 KiB
C
/* Copyright Statement:
|
|
*
|
|
* This software/firmware and related documentation ("AutoChips Software") are
|
|
* protected under relevant copyright laws. The information contained herein is
|
|
* confidential and proprietary to AutoChips Inc. and/or its licensors. Without
|
|
* the prior written permission of AutoChips inc. and/or its licensors, any
|
|
* reproduction, modification, use or disclosure of AutoChips Software, and
|
|
* information contained herein, in whole or in part, shall be strictly
|
|
* prohibited.
|
|
*
|
|
* AutoChips Inc. (C) 2021. All rights reserved.
|
|
*
|
|
* BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
|
|
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("AUTOCHIPS SOFTWARE")
|
|
* RECEIVED FROM AUTOCHIPS AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
|
|
* ON AN "AS-IS" BASIS ONLY. AUTOCHIPS EXPRESSLY DISCLAIMS ANY AND ALL
|
|
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
|
|
* NONINFRINGEMENT. NEITHER DOES AUTOCHIPS PROVIDE ANY WARRANTY WHATSOEVER WITH
|
|
* RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
|
|
* INCORPORATED IN, OR SUPPLIED WITH THE AUTOCHIPS SOFTWARE, AND RECEIVER AGREES
|
|
* TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
|
|
* RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
|
|
* OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN AUTOCHIPS
|
|
* SOFTWARE. AUTOCHIPS SHALL ALSO NOT BE RESPONSIBLE FOR ANY AUTOCHIPS SOFTWARE
|
|
* RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
|
|
* STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND AUTOCHIPS'S
|
|
* ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE AUTOCHIPS SOFTWARE
|
|
* RELEASED HEREUNDER WILL BE, AT AUTOCHIPS'S OPTION, TO REVISE OR REPLACE THE
|
|
* AUTOCHIPS SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
|
|
* CHARGE PAID BY RECEIVER TO AUTOCHIPS FOR SUCH AUTOCHIPS SOFTWARE AT ISSUE.
|
|
*/
|
|
|
|
/*!
|
|
* @file pbr_drv.h
|
|
*
|
|
* @brief This file provides pbr integration functions interface.
|
|
*
|
|
*/
|
|
|
|
#ifndef PBR_DRV_H
|
|
#define PBR_DRV_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/* ============================================ Include ============================================= */
|
|
#include "device_register.h"
|
|
|
|
/*=====================================SOURCE FILE VERSION INFORMATION==============================*/
|
|
#define PBR_HAL_MODULE_ID (23U)
|
|
#define PBR_HAL_SW_MAJOR_VERSION (1U)
|
|
#define PBR_HAL_SW_MINOR_VERSION (1U)
|
|
#define PBR_HAL_SW_PATCH_VERSION (0U)
|
|
|
|
/* ============================================ Define ============================================ */
|
|
#define PERIPH_ACCESS_MASK (0xFUL)
|
|
#define PERIPH_ONE_GROUP_NUM (0x8UL)
|
|
#define PERIPH_ACCESS_BIT_NUM (0x4UL)
|
|
|
|
/* =========================================== Typedef ============================================ */
|
|
/*!
|
|
* @brief PBR master privilege level.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_MASTER_FORCE_USER_MODE = 0U,
|
|
PBR_MASTER_NOT_FORCE_USER_MODE
|
|
} pbr_master_pl_t;
|
|
|
|
/*!
|
|
* @brief PBR master trusted for write.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_MASTER_NOT_TRUST_WRITE = 0U,
|
|
PBR_MASTER_TRUST_WRITE
|
|
} pbr_master_tw_t;
|
|
|
|
/*!
|
|
* @brief PBR master trusted for read.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_MASTER_NOT_TRUST_READ = 0U,
|
|
PBR_MASTER_TRUST_READ
|
|
} pbr_master_tr_t;
|
|
|
|
/*!
|
|
* @brief PBR peripheral trust protect.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_PERI_ALLOW_UNTRUST_MASTER = 0U,
|
|
PBR_PERI_NOT_ALLOW_UNTRUST_MASTER
|
|
} pbr_peri_tp_t;
|
|
|
|
/*!
|
|
* @brief PBR peripheral write protect.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_PERI_ALLOW_WRITE = 0U,
|
|
PBR_PERI_WRITE_PROTECT
|
|
} pbr_peri_wp_t;
|
|
|
|
/*!
|
|
* @brief PBR peripheral supervisor protect.
|
|
*/
|
|
typedef enum
|
|
{
|
|
PBR_PERI_NOT_REQ_SUPER_PRIV = 0U,
|
|
PBR_PERI_REQ_SUPER_PRIV
|
|
} pbr_peri_sp_t;
|
|
|
|
/* ========================================== Variables =========================================== */
|
|
|
|
/* ==================================== Functions declaration ===================================== */
|
|
/*!
|
|
* @brief Set master privilege.
|
|
*
|
|
* @param[in] master: pbr master
|
|
* @param[in] mtr: master trust for read
|
|
* @param[in] mtw: master trust for write
|
|
* @param[in] mpl: master privilege level
|
|
* @return none
|
|
*/
|
|
void PBR_DRV_SetMasterPrivilege(pbr_master_t master, pbr_master_tr_t mtr, pbr_master_tw_t mtw, pbr_master_pl_t mpl);
|
|
|
|
/*!
|
|
* @brief Set peripheral access control.
|
|
*
|
|
* @param[in] peri: pbr peripheral
|
|
* @param[in] sp: peripheral supervisor protect
|
|
* @param[in] wp: peripheral write protect
|
|
* @param[in] tp: peripheral trust protect
|
|
* @return none
|
|
*/
|
|
void PBR_DRV_SetPeripheralAccess(pbr_peripheral_t peri, pbr_peri_sp_t sp, pbr_peri_wp_t wp, pbr_peri_tp_t tp);
|
|
|
|
/*!
|
|
* @brief Get module version information.
|
|
*
|
|
* @param[out] versionInfo: Module version information address.
|
|
* @return void
|
|
*/
|
|
void PBR_DRV_GetVersionInfo(Drv_VersionInfo_Type *versionInfo);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* PBR_DRV_H */
|
|
|
|
/* ============================================= EOF ============================================== */
|