hpm_pmp_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2025 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
#ifndef HPM_PMP_DRV_H
#define HPM_PMP_DRV_H
 
#include "hpm_common.h"
#include "hpm_soc_feature.h"
 
typedef struct pmp_entry_struct {
    union {
        struct {
            uint8_t read_access_ctrl   : 1;
            uint8_t write_access_ctrl  : 1;
            uint8_t execution_ctrl     : 1;
            uint8_t addr_matching_mode : 2;
            uint8_t reserved           : 2;
            uint8_t lock               : 1;
        };
        uint8_t val;
    } pmp_cfg;
    uint8_t reserved0[3];
    uint32_t pmp_addr;
#if (!defined(PMP_SUPPORT_PMA)) || (defined(PMP_SUPPORT_PMA) && (PMP_SUPPORT_PMA == 1))
    union {
        struct {
            uint8_t entry_addr_matching_mode   : 2;
            uint8_t mem_type_attribute         : 4;
            uint8_t atomic_mem_operation_ctrl  : 1;
            uint8_t reserved                   : 1;
        };
        uint8_t val;
    } pma_cfg;
    uint8_t reserved1[3];
    uint32_t pma_addr;
#endif
} pmp_entry_t;
 
typedef struct pmp_attribute_struct {
    union {
        struct {
            uint8_t read_access_ctrl   : 1;
            uint8_t write_access_ctrl  : 1;
            uint8_t execution_ctrl     : 1;
            uint8_t addr_matching_mode : 2;
            uint8_t reserved           : 2;
            uint8_t lock               : 1;
        };
        uint8_t val;
    } pmp_cfg;
    uint8_t reserved0[3];
    uint32_t pmp_addr;
} pmp_attr_t;
 
typedef struct pma_attribute_struct {
    union {
        struct {
            uint8_t entry_addr_matching_mode   : 2;
            uint8_t mem_type_attribute         : 4;
            uint8_t atomic_mem_operation_ctrl  : 1;
            uint8_t reserved                   : 1;
        };
        uint8_t val;
    } pma_cfg;
    uint8_t reserved1[3];
    uint32_t pma_addr;
} pma_attr_t;
 
#define READ_EN             (1U)
#define READ_DIS            (0U)
#define WRITE_EN            (1U)
#define WRITE_DIS           (0U)
#define EXECUTE_EN          (1U)
#define EXECUTE_DIS         (0U)
#define ADDR_MATCH_MODE_OFF (0U)
#define ADDR_MATCH_TOR      (1U)
#define ADDR_MATCH_NAPOT    (3U)
#define REG_LOCK            (1U)
#define REG_UNLOCK          (0U)
#define PMP_REG_LOCK_MASK   (1UL << 7)
 
#define MEM_TYPE_DEV_NON_BUF             (0U)
#define MEM_TYPE_DEV_BUF                 (1U)
#define MEM_TYPE_MEM_NON_CACHE_NON_BUF   (2U)
#define MEM_TYPE_MEM_NON_CACHE_BUF       (3U)
#define MEM_TYPE_MEM_WT_NO_ALLOC         (4U)
#define MEM_TYPE_MEM_WT_READ_ALLOC       (5U)
#define MEM_TYPE_MEM_WB_NO_ALLOC         (8U)
#define MEM_TYPE_MEM_WB_READ_ALLOC       (9U)
#define MEM_TYPE_MEM_WB_WRITE_ALLOC      (10U)
#define MEM_TYPE_MEM_WB_READ_WRITE_ALLOC (11U)
#define MEM_TYPE_EMPTY_HOLE              (15U)
 
#define AMO_EN  (0U)
#define AMO_DIS (1U)
 
#define PMP_CFG(r, w, x, m, l) ((r) | ((w) << 1) | ((x) << 2) | ((m) << 3) | ((l) << 7))
#define PMA_CFG(m, t, n) ((m) | ((t) << 2) | ((n) << 6))
#define PMP_TOR_ADDR(addr) ((addr) >> 2)
#define PMP_NAPOT_ADDR(x, n) (((uint32_t)(x) + (((uint32_t)(n)) >> 1) - 1U) >> 2)
#define PMA_NAPOT_ADDR(x, n) (((uint32_t)(x) + (((uint32_t)(n)) >> 1) - 1U) >> 2)
 
#ifdef __cplusplus
extern "C" {
#endif
void write_pmp_cfg(uint32_t value, uint32_t idx);
 
uint32_t read_pmp_cfg(uint32_t idx);
 
void write_pmp_addr(uint32_t value, uint32_t idx);
 
uint32_t read_pmp_addr(uint32_t idx);
 
hpm_stat_t pmp_config_attributes(const pmp_attr_t *attrs, uint32_t num_of_entries);
 
hpm_stat_t pmp_lock_pmp_entry(uint32_t pmp_index);
 
#if (!defined(PMP_SUPPORT_PMA)) || (defined(PMP_SUPPORT_PMA) && (PMP_SUPPORT_PMA == 1))
uint32_t read_pma_cfg(uint32_t idx);
 
void write_pma_cfg(uint32_t value, uint32_t idx);
 
void write_pma_addr(uint32_t value, uint32_t idx);
 
uint32_t read_pma_addr(uint32_t idx);
 
hpm_stat_t pma_config_attributes(const pma_attr_t *attrs, uint32_t num_of_entries);
#endif /* #if (!defined(PMP_SUPPORT_PMA)) || (defined(PMP_SUPPORT_PMA) && (PMP_SUPPORT_PMA == 1)) */
 
hpm_stat_t pmp_config_entry(const pmp_entry_t *entry, uint32_t entry_index);
 
hpm_stat_t pmp_config(const pmp_entry_t *entry, uint32_t num_of_entries);
 
 
uint32_t pmp_get_aligned_len(uint32_t len);
 
void pmp_disable(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HPM_PMP_DRV_H */