Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
nxp_rtxxx_dsp_ctrl.h File Reference

Go to the source code of this file.

Data Structures

struct  nxp_rtxxx_dsp_ctrl_api
 

Typedefs

typedef int(* nxp_rtxxx_dsp_ctrl_api_load_section) (const struct device *, const void *, size_t, enum nxp_rtxxx_dsp_ctrl_section_type)
 
typedef void(* nxp_rtxxx_dsp_ctrl_api_enable) (const struct device *dev)
 
typedef void(* nxp_rtxxx_dsp_ctrl_api_disable) (const struct device *dev)
 

Enumerations

enum  nxp_rtxxx_dsp_ctrl_section_type { NXP_RTXXX_DSP_CTRL_SECTION_RESET = 0 , NXP_RTXXX_DSP_CTRL_SECTION_TEXT = 1 , NXP_RTXXX_DSP_CTRL_SECTION_DATA = 2 }
 Describes an image section type selection. More...
 

Functions

static int nxp_rtxxx_dsp_ctrl_load_section (const struct device *dev, const void *base, size_t length, enum nxp_rtxxx_dsp_ctrl_section_type section)
 Loads a specified image representing a specified section to a particular region in the DSP's memory.
 
static void nxp_rtxxx_dsp_ctrl_enable (const struct device *dev)
 Starts (unstalls) the DSP.
 
static void nxp_rtxxx_dsp_ctrl_disable (const struct device *dev)
 Stops (stalls) the DSP.
 

Typedef Documentation

◆ nxp_rtxxx_dsp_ctrl_api_disable

typedef void(* nxp_rtxxx_dsp_ctrl_api_disable) (const struct device *dev)

◆ nxp_rtxxx_dsp_ctrl_api_enable

typedef void(* nxp_rtxxx_dsp_ctrl_api_enable) (const struct device *dev)

◆ nxp_rtxxx_dsp_ctrl_api_load_section

typedef int(* nxp_rtxxx_dsp_ctrl_api_load_section) (const struct device *, const void *, size_t, enum nxp_rtxxx_dsp_ctrl_section_type)

Enumeration Type Documentation

◆ nxp_rtxxx_dsp_ctrl_section_type

Describes an image section type selection.

Enumerator
NXP_RTXXX_DSP_CTRL_SECTION_RESET 
NXP_RTXXX_DSP_CTRL_SECTION_TEXT 
NXP_RTXXX_DSP_CTRL_SECTION_DATA 

Function Documentation

◆ nxp_rtxxx_dsp_ctrl_disable()

static void nxp_rtxxx_dsp_ctrl_disable ( const struct device * dev)
inlinestatic

Stops (stalls) the DSP.

Parameters
devDSP device

◆ nxp_rtxxx_dsp_ctrl_enable()

static void nxp_rtxxx_dsp_ctrl_enable ( const struct device * dev)
inlinestatic

Starts (unstalls) the DSP.

Parameters
devDSP device

◆ nxp_rtxxx_dsp_ctrl_load_section()

static int nxp_rtxxx_dsp_ctrl_load_section ( const struct device * dev,
const void * base,
size_t length,
enum nxp_rtxxx_dsp_ctrl_section_type section )
inlinestatic

Loads a specified image representing a specified section to a particular region in the DSP's memory.

Parameters
devDSP device
baseBase pointer of the image to load
lengthLength of the image
sectionSection type which specified image represents
Returns
int 0 on success, -EINVAL for invalid parameters, -ENOMEM for image bigger than the target region