sdrv_scr.h

Go to the documentation of this file.

 
#ifndef _SDRV_SCR_H_
#define _SDRV_SCR_H_
 
#include <sdrv_common.h>
#include <types.h>
 
/* SCR signal types. */
#define TYPE_RW 0u
#define TYPE_RO 1u
#define TYPE_L16 2u
#define TYPE_L31 3u
#define TYPE_R16W16 4u
 
typedef struct scr_signal {
    uint16_t type;
    uint16_t start_bit;
    uint16_t width;
} scr_signal_t;
 
typedef struct sdrv_scr {
    paddr_t base; 
} sdrv_scr_t;
 
enum {
    /* The signal is locked, so it cannot be updated. */
    SDRV_SCR_LOCKED = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_SCR, 0),
    /* The signal is locked, or not L16/L31, so it cannot be locked. */
    SDRV_SCR_CANNOT_LOCK = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_SCR, 1),
    /* The signal isn't writeable. */
    SDRV_SCR_CANNOT_WRITE = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_SCR, 2),
};
 
uint32_t scr_get(const sdrv_scr_t *scr, const scr_signal_t *signal);
 
status_t scr_set(const sdrv_scr_t *scr, const scr_signal_t *signal, uint32_t value);
 
status_t scr_lock(const sdrv_scr_t *scr, const scr_signal_t *signal);
 
bool scr_is_locked(const sdrv_scr_t *scr, const scr_signal_t *signal);
 
#endif /*_SDRV_SCR_H_*/