sdl_vim.h File Reference

Introduction

Header file containing various enumerations, structure definitions and function

declarations for the VIM IP.

(C) Copyright 2022, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Go to the source code of this file.

Data Structures
struct	SDL_vimStaticRegs_GRP
	This structure defines the group registers identified for VIM static registers. More...
struct	SDL_vimStaticRegs
	This structure defines the static register groups identified for VIM. More...

Macros
vim interrupt groups.
#define	SDL_VIM_MAX_INTR_GROUPS   (32U)
#define	SDL_VIM_NUM_INTRS_PER_GROUP   (32U)
vim interrupt types
#define	SDL_VIM_INTR_TYPE_LEVEL   ((uint32_t)0U)
#define	SDL_VIM_INTR_TYPE_PULSE   ((uint32_t)1U)
vim interrupt maps
#define	SDL_VIM_INTR_MAP_IRQ   ((uint32_t)0U)
#define	SDL_VIM_INTR_MAP_FIQ   ((uint32_t)1U)
#define	SDL_VIM_INTR_MAP_ALL   ((uint32_t)2U)

Typedefs
typedef uint32_t	SDL_VimIntrType
	This enumerator defines the possible interrupt types. Each source interrupt is either an active high level or active high pulse. More...
typedef uint32_t	SDL_VimIntrMap
	This enumerator defines the possible output interrupt types. Each source interrupt can be configured to drive either the IRQ or FIQ output signal. More...

Functions
uint32_t	SDL_VIM_getRevision (SDL_vimRegs *pRegs)
	Return revision of the VIM module. More...
uint32_t	SDL_VIM_getNumIntrs (SDL_vimRegs *pRegs)
	Get the number of interrupts supported by this VIM. More...
int32_t	SDL_VIM_cfgIntr (SDL_vimRegs *pRegs, uint32_t intrNum, uint32_t pri, SDL_VimIntrMap intrMap, SDL_VimIntrType intrType, uint32_t vecAddr)
	Configure a source interrupt using VIM. More...
int32_t	SDL_VIM_verifyCfgIntr (SDL_vimRegs *pRegs, uint32_t intrNum, uint32_t pri, SDL_VimIntrMap intrMap, SDL_VimIntrType intrType, uint32_t vecAddr)
	Read back Verify Configure a source interrupt. More...
int32_t	SDL_VIM_getIntrType (SDL_vimRegs *pRegs, uint32_t intrNum)
	Get the interrupt type. More...
void	SDL_VIM_setDedVectorAddr (SDL_vimRegs *pRegs, uint32_t dedVectorAddr)
	Set the DED interrupt vector address. More...
int32_t	SDL_VIM_getDedVectorAddr (SDL_vimRegs *pRegs, uint32_t *pDedVectorAddr)
	Get the DED interrupt vector address. More...
int32_t	SDL_VIM_getActivePendingIntr (SDL_vimRegs *pRegs, SDL_VimIntrMap intrMap, uint32_t *pIntrNum, uint32_t *pPri)
	Get information on the current highest priority pending interrupt. More...
uint32_t	SDL_VIM_getIrqVectorAddress (SDL_vimRegs *pRegs)
	Get the current IRQ vector address. More...
uint32_t	SDL_VIM_getFiqVectorAddress (SDL_vimRegs *pRegs)
	Get the current FIQ vector address. More...
uint32_t	SDL_VIM_getGroupsIntrPending (SDL_vimRegs *pRegs, SDL_VimIntrMap intrMap)
	Get bit-mask of masked interrupt status for all interrupt groups. More...
uint32_t	SDL_VIM_getGroupIntrPending (SDL_vimRegs *pRegs, SDL_VimIntrMap intrMap, uint32_t groupNum, bool bMasked)
	Get bit-mask of raw or masked interrupt status for all interrupts within a group. More...
int32_t	SDL_VIM_setIntrPending (SDL_vimRegs *pRegs, uint32_t intrNum)
	Set the raw interrupt status bit for the specified interrupt. More...
int32_t	SDL_VIM_clrIntrPending (SDL_vimRegs *pRegs, uint32_t intrNum)
	Clear the raw interrupt status bit for the specified interrupt. More...
int32_t	SDL_VIM_ackIntr (SDL_vimRegs *pRegs, SDL_VimIntrMap intrMap)
	Acknowledge servicing is complete for the specified interrupt type. More...
int32_t	SDL_VIM_setIntrEnable (SDL_vimRegs *pRegs, uint32_t intrNum, bool bEnable)
	Enable or disable interrupt status mask for the specified interrupt. More...
int32_t	SDL_VIM_getStaticRegs (SDL_vimRegs *pRegs, SDL_vimStaticRegs *pStaticRegs)
	Read back of static registers for VIM. More...