sdrv_scr.h File Reference

#include <sdrv_common.h>
#include <types.h>

Go to the source code of this file.

Data Structures
struct	scr_signal
struct	sdrv_scr

Typedefs
typedef struct scr_signal	scr_signal_t

Functions
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)

Detailed Description

Copyright

Copyright (c) 2022 Semidrive Semiconductor. All rights reserved.

Macro Definition Documentation

TYPE_L16

#define TYPE_L16   2u

TYPE_L31

#define TYPE_L31   3u

TYPE_R16W16

#define TYPE_R16W16   4u

TYPE_RO

#define TYPE_RO   1u

TYPE_RW

#define TYPE_RW   0u

Typedef Documentation

scr_signal_t

typedef struct scr_signal scr_signal_t

SCR signal structure.

Note

Do NOT define SCR signals by yourself. Use signals defined in "scr_hw.h", which is automatically generated.

sdrv_scr_t

typedef struct sdrv_scr sdrv_scr_t

SCR device structure.

Enumeration Type Documentation

anonymous enum

anonymous enum

SCR driver error codes.

Enumerator
SDRV_SCR_LOCKED
SDRV_SCR_CANNOT_LOCK
SDRV_SCR_CANNOT_WRITE

Function Documentation

scr_get()

uint32_t scr_get	(	const sdrv_scr_t *	scr,
		const scr_signal_t *	signal
	)

Get value of signal.

Parameters

scr	SCR controller.
signal	Signal defined in "scr_hw.h".

Returns

Signal value.

scr_is_locked()

bool scr_is_locked	(	const sdrv_scr_t *	scr,
		const scr_signal_t *	signal
	)

Check the lock status of signal.

Parameters

scr	SCR controller.
signal	Signal defined in "scr_hw.h", which should be of L16/L31 type.

Returns

True if signal is locked.

scr_lock()

status_t scr_lock	(	const sdrv_scr_t *	scr,
		const scr_signal_t *	signal
	)

Lock the given signal.

Parameters

scr	SCR controller.
signal	Signal defined in "scr_hw.h", which should be of L16/L31 type.

Returns

SDRV_STATUS_OK if successfully locked signal.

scr_set()

status_t scr_set	(	const sdrv_scr_t *	scr,
		const scr_signal_t *	signal,
		uint32_t	value
	)

Set value of signal.

Parameters

scr	SCR controller.
signal	Signal defined in "scr_hw.h".
value	Signal value.

Returns

SDRV_STATUS_OK if successfully set. SDRV_SCR_LOCKED if signal is locked, or SDRV_SCR_CANNOT_WRITE if signal is read only.