hpm_otp_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
#ifndef HPM_OTP_DRV_H
#define HPM_OTP_DRV_H
 
#include "hpm_common.h"
 
/***********************************************************************************************************************
 * Definitions
 **********************************************************************************************************************/
typedef enum {
    otp_region0_mask = 1U,  
    otp_region1_mask = 2U,  
    otp_region2_mask = 4U,  
    otp_region3_mask = 8U,  
} otp_region_t;
 
typedef enum {
    otp_no_lock = 0,
    otp_read_only = 1,
    otp_permanent_no_lock = 2,
    otp_disable_access = 3,
    otp_lock_option_max = otp_disable_access,
} otp_lock_option_t;
 
enum {
    otp_write_disallowed = MAKE_STATUS(status_group_otp, 0),
};
 
/***********************************************************************************************************************
 * Prototypes
 **********************************************************************************************************************/
#ifdef __cpluscplus
extern "C" {
#endif
 
void otp_init(void);
 
void otp_deinit(void);
 
uint32_t otp_read_from_shadow(uint32_t addr);
 
uint32_t otp_read_from_ip(uint32_t addr);
 
hpm_stat_t otp_program(uint32_t addr, const uint32_t *src, uint32_t num_of_words);
 
hpm_stat_t otp_reload(otp_region_t region);
 
hpm_stat_t otp_lock_otp(uint32_t addr, otp_lock_option_t lock_option);
 
hpm_stat_t otp_lock_shadow(uint32_t addr, otp_lock_option_t lock_option);
 
hpm_stat_t otp_set_configurable_region(uint32_t start, uint32_t num_of_words);
 
hpm_stat_t otp_write_shadow_register(uint32_t addr, uint32_t val);
 
 
#ifdef __cpluscplus
}
#endif
#endif