nrf_semmc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_SEMMC_H__
#define NRF_SEMMC_H__
 
#include <stdbool.h>
#include <stdint.h>
#include "nrf_config_semmc.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum
{
    NRF_SEMMC_CMD0_GO_IDLE_STATE         = 0,
    NRF_SEMMC_CMD1_SEND_OP_COND          = 1,
    NRF_SEMMC_CMD2_ALL_SEND_CID          = 2,
    NRF_SEMMC_CMD3_SET_RELATIVE_ADDR     = 3,
    NRF_SEMMC_CMD4_SET_DSR               = 4,
    NRF_SEMMC_CMD5_SLEEP_AWAKE           = 5,
    NRF_SEMMC_CMD6_SWITCH                = 6,
    NRF_SEMMC_CMD7_SELECT_DESELECT       = 7,
    NRF_SEMMC_CMD8_SEND_EXT_CSD          = 8,
    NRF_SEMMC_CMD9_SEND_CSD              = 9,
    NRF_SEMMC_CMD10_SEND_CID             = 10,
    NRF_SEMMC_CMD12_STOP_TRANSMISSION    = 12,
    NRF_SEMMC_CMD13_SEND_STATUS          = 13,
    NRF_SEMMC_CMD14_BUSTEST_R            = 14,
    NRF_SEMMC_CMD15_GO_INACTIVE_STATE    = 15,
    NRF_SEMMC_CMD16_SET_BLOCKLEN         = 16,
    NRF_SEMMC_CMD17_READ_SINGLE          = 17,
    NRF_SEMMC_CMD18_READ_MULTIPLE        = 18,
    NRF_SEMMC_CMD19_BUSTEST_W            = 19,
    NRF_SEMMC_CMD21_SEND_TUNING_BLOCK    = 21,
    NRF_SEMMC_CMD23_SET_BLOCK_COUNT      = 23,
    NRF_SEMMC_CMD24_WRITE_BLOCK          = 24,
    NRF_SEMMC_CMD25_WRITE_MULTIPLE       = 25,
    NRF_SEMMC_CMD26_PROGRAM_CID          = 26,
    NRF_SEMMC_CMD27_PROGRAM_CSD          = 27,
    NRF_SEMMC_CMD28_SET_WRITE_PROT       = 28,
    NRF_SEMMC_CMD29_CLR_WRITE_PROT       = 29,
    NRF_SEMMC_CMD30_SEND_WRITE_PROT      = 30,
    NRF_SEMMC_CMD31_SEND_WRITE_PROT_TYPE = 31,
    NRF_SEMMC_CMD35_ERASE_GROUP_START    = 35,
    NRF_SEMMC_CMD36_ERASE_GROUP_END      = 36,
    NRF_SEMMC_CMD38_ERASE                = 38,
    NRF_SEMMC_CMD42_LOCK_UNLOCK          = 42,
    NRF_SEMMC_CMD44_QUEUED_TASK_PARAMS   = 44,
    NRF_SEMMC_CMD45_QUEUED_TASK_ADDRESS  = 45,
    NRF_SEMMC_CMD46_EXECUTE_READ_TASK    = 46,
    NRF_SEMMC_CMD47_EXECUTE_WRITE_TASK   = 47,
    NRF_SEMMC_CMD48_CMDQ_TASK_MGMT       = 48,
    NRF_SEMMC_CMD49_SET_TIME             = 49,
} nrf_semmc_cmd_t;
 
typedef enum
{
    NRF_SEMMC_RESP_NONE,
    NRF_SEMMC_RESP_R1,
    NRF_SEMMC_RESP_R1B,
    NRF_SEMMC_RESP_R2,
    NRF_SEMMC_RESP_R3,
    NRF_SEMMC_RESP_R4,
    NRF_SEMMC_RESP_R5,
} nrf_semmc_resp_type_t;
 
typedef enum
{
    NRF_SEMMC_SUCCESS = 0,
    NRF_SEMMC_ERROR_TIMEOUT,
    NRF_SEMMC_ERROR_CMDTIMEOUT,
    NRF_SEMMC_ERROR_CMDCRCERROR,
    NRF_SEMMC_ERROR_DATACRCERROR,
    NRF_SEMMC_ERROR_ILLEGAL_CMD,
    NRF_SEMMC_ERROR_DEVICE_REJECTED,
    NRF_SEMMC_ERROR_INTERNAL_OR_PROTOCOL,
    NRF_SEMMC_ERROR_BUSY,
    NRF_SEMMC_ERROR_UNSUPPORTED,
    NRF_SEMMC_ERROR_INVALID_PARAM,
    NRF_SEMMC_ERROR_INVALID_STATE,
    NRF_SEMMC_ERROR_HW_FAULT,
} nrf_semmc_error_t;
 
typedef enum
{
    NRF_SEMMC_BUS_WIDTH_1 = 1,
    NRF_SEMMC_BUS_WIDTH_4 = 4,
    NRF_SEMMC_BUS_WIDTH_8 = 8,
} nrf_semmc_bus_width_t;
 
typedef enum
{
    NRF_SEMMC_EVT_XFER_DONE,                   
    NRF_SEMMC_EVT_XFER_STARTED,                
} nrf_semmc_event_type_t;
 
typedef enum
{
    NRF_SEMMC_RESULT_OK,                       
    NRF_SEMMC_RESULT_ABORTED,                  
} nrf_semmc_event_xfer_done_t;
 
typedef struct
{
    nrf_semmc_event_type_t type;               
    union
    {
        nrf_semmc_event_xfer_done_t xfer_done; 
    }                      data;               
} nrf_semmc_event_t;
 
typedef void (* nrf_semmc_event_handler_t)(nrf_semmc_event_t const * p_event, void * p_context);
 
typedef struct
{
    void *                spis_instance;                     
    uint32_t              process_response;                  
    uint32_t              clk_freq_hz;                       
    uint32_t              read_delay;                        
    nrf_semmc_bus_width_t bus_width;                         
} nrf_semmc_config_t;
 
typedef struct
{
    uint8_t               cmd;                               
    uint32_t              arg;                               
    nrf_semmc_resp_type_t resp_type;                         
    void *                resp_buffer;                       
    uint32_t              response[NRF_SEMMC_RESPONSE_SIZE]; 
    nrf_semmc_error_t     err;                               
} nrf_semmc_cmd_desc_t;
 
typedef struct
{
    void *   buffer;     
    uint32_t block_size; 
    uint32_t num_blocks; 
    /*
     * The block_addr is intentionally not included here as it's supplied in the
     * 'arg' field of the associated command descriptor (nrf_semmc_cmd_desc_t)
     */
} nrf_semmc_transfer_desc_t;
 
#define NRF_SEMMC_FLAG_HOLD_XFER (1UL << 0)
 
typedef struct
{
    void * p_reg;        
    uint8_t
           drv_inst_idx; 
} nrf_semmc_t;
 
nrf_semmc_error_t nrf_semmc_init(nrf_semmc_t const *       p_semmc,
                                 nrf_semmc_event_handler_t handler,
                                 void *                    p_context);
 
void nrf_semmc_uninit(nrf_semmc_t const * p_semmc);
 
nrf_semmc_error_t nrf_semmc_enable(nrf_semmc_t const * p_semmc);
 
nrf_semmc_error_t nrf_semmc_disable(nrf_semmc_t const * p_semmc);
 
nrf_semmc_error_t nrf_semmc_cmd(nrf_semmc_t const *         p_semmc,
                                nrf_semmc_cmd_desc_t *      p_cmd,
                                nrf_semmc_config_t const *  p_config,
                                nrf_semmc_transfer_desc_t * p_transfer,
                                size_t                      cmd_count,
                                uint32_t                    flags);
 
nrf_semmc_error_t nrf_semmc_cmd_prepare(nrf_semmc_t const *         p_semmc,
                                        nrf_semmc_cmd_desc_t *      p_cmd,
                                        nrf_semmc_config_t const *  p_config,
                                        nrf_semmc_transfer_desc_t * p_transfer,
                                        size_t                      cmd_count);
 
uint32_t * nrf_semmc_start_task_address_get(nrf_semmc_t const * p_semmc);
 
nrf_semmc_error_t nrf_semmc_abort(nrf_semmc_t const * p_semmc);
 
bool nrf_semmc_is_busy(nrf_semmc_t const * p_semmc);
 
void nrf_semmc_irq_handler(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // NRF_SEMMC_H__