hrt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _HRT_H__
#define _HRT_H__
 
#include <stdint.h>
#include <stdbool.h>
#include <drivers/mspi/hpf_mspi.h>
#include <zephyr/drivers/mspi.h>
 
#define VPRCSR_NORDIC_OUT_HIGH 1
#define VPRCSR_NORDIC_OUT_LOW  0
 
#define VPRCSR_NORDIC_DIR_OUTPUT 1
#define VPRCSR_NORDIC_DIR_INPUT  0
#define VPRCSR_NORDIC_PIN_USED   1
 
#define BITS_IN_WORD 32
#define BITS_IN_BYTE 8
 
typedef enum {
        HRT_FE_COMMAND,
        HRT_FE_ADDRESS,
        HRT_FE_DUMMY_CYCLES,
        HRT_FE_DATA,
        HRT_FE_MAX
} hrt_frame_element_t;
 
typedef enum {
        HRT_FUN_OUT_BYTE,
        HRT_FUN_OUT_WORD,
} hrt_fun_out_t;

typedef struct {
        uint8_t command;
        uint8_t address;
        uint8_t dummy_cycles;
        uint8_t data;
} hrt_xfer_bus_widths_t;
 
typedef struct {
        volatile uint8_t *data;

        uint32_t word_count;

        uint8_t last_word_clocks;

        uint8_t penultimate_word_clocks;

        uint32_t last_word;

        hrt_fun_out_t fun_out;
} hrt_xfer_data_t;

typedef struct {

        hrt_xfer_data_t xfer_data[HRT_FE_MAX];

        hrt_xfer_bus_widths_t bus_widths;

        uint16_t counter_value;

        uint8_t ce_vio;

        bool ce_hold;

        enum mspi_ce_polarity ce_polarity;

        uint16_t used_pins_mask;

        enum mspi_cpp_mode cpp_mode;
 
} hrt_xfer_t;

void hrt_write(volatile hrt_xfer_t *hrt_xfer_params);

void hrt_read(volatile hrt_xfer_t *hrt_xfer_params);
 
#endif /* _HRT_H__ */