Files
rtems/bsps/include/grlib/gr1553b.h
T

388 lines
15 KiB
C

/* SPDX-License-Identifier: BSD-2-Clause */
/* GR1553B driver, used by BC, RT and/or BM driver
*
* COPYRIGHT (c) 2010.
* Cobham Gaisler AB.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* 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.
*
* OVERVIEW
* ========
* This driver controls the GR1553B device regardless of interfaces supported
* (BC, RT and/or BM). The device can be located at an on-chip AMBA or an
* AMBA-over-PCI bus. This driver provides an interface for the BC, RT and BM
* drivers to use. Since the different interfaces are accessed over the same
* register interface on the same core, the other drivers must share a GR1553B
* device. Any combination of interface functionality is supported, but the RT
* and BC functionality can nnot be used simultaneously due to hardware
* limitation.
*
*/
#ifndef __GR1553B_H__
#define __GR1553B_H__
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/* The GR1553B registers */
struct gr1553b_regs {
/* Common Registers */
volatile uint32_t irq; /* 0x00 IRQ register */
volatile uint32_t imask; /* 0x04 IRQ enable mask */
int unused0[ ( 0x10 - 0x08 ) / 4 ];
volatile uint32_t hwcfg; /* 0x10 HW config register */
int unused1[ ( 0x40 - 0x14 ) / 4 ]; /* Padding */
/* BC Registers */
volatile uint32_t bc_stat; /* 0x40 BC status */
volatile uint32_t bc_ctrl; /* 0x44 BC Action register */
volatile uint32_t bc_bd; /* 0x48 BC transfer list pointer */
volatile uint32_t bc_abd; /* 0x4c BC async list pointer */
volatile uint32_t bc_timer; /* 0x50 BC timer register */
volatile uint32_t bc_wake; /* 0x54 BC wakeup control register */
volatile uint32_t bc_irqptr; /* 0x58 BC transfer IRQ pointer */
volatile uint32_t bc_busmsk; /* 0x5C BC per-RT bus mask register */
int unused2[ ( 0x68 - 0x60 ) / 4 ]; /* Padding */
volatile uint32_t bc_slot; /* 0x68 BC Current BD pointer */
volatile uint32_t bc_aslot; /* 0x6c BC Current async BD pointer */
int unused3[ ( 0x80 - 0x70 ) / 4 ]; /* Padding */
/* RT Registers */
volatile uint32_t rt_stat; /* 0x80 RT status */
volatile uint32_t rt_cfg; /* 0x84 RT config register */
volatile uint32_t rt_stat2; /* 0x88 RT bus status bits */
volatile uint32_t rt_statw; /* 0x8c RT status words */
volatile uint32_t rt_sync; /* 0x90 RT bus synchronize */
volatile uint32_t rt_tab; /* 0x94 RT subaddress table base */
volatile uint32_t rt_mcctrl; /* 0x98 RT valid mode code mask */
int unused4[ ( 0xa4 - 0x9c ) / 4 ];
volatile uint32_t rt_ttag; /* 0xa4 RT time tag register */
int unused5; /* 0xa8 RESERVED */
volatile uint32_t rt_evsz; /* 0xac RT event log end pointer */
volatile uint32_t rt_evlog; /* 0xb0 RT event log position */
volatile uint32_t rt_evirq; /* 0xb4 RT event log IRQ position */
int unused6[ ( 0xc0 - 0xb8 ) / 4 ]; /* Padding */
/* BM Registers */
volatile uint32_t bm_stat; /* 0xc0 BM status */
volatile uint32_t bm_ctrl; /* 0xc4 BM control register */
volatile uint32_t bm_adr; /* 0xc8 BM address filter */
volatile uint32_t bm_subadr; /* 0xcc BM subaddress filter */
volatile uint32_t bm_mc; /* 0xd0 BM mode code filter */
volatile uint32_t bm_start; /* 0xd4 BM log start address */
volatile uint32_t bm_end; /* 0xd8 BM log size/alignment mask */
volatile uint32_t bm_pos; /* 0xdc BM log position */
volatile uint32_t bm_ttag; /* 0xe0 BM time tag register */
};
#define GR1553BC_KEY 0x15520000
#define GR1553RT_KEY 0x15530000
/* IRQ Definitions */
#define GR1553BC_IRQLOG_SIZE 64
#define GR1553BC_IRQLOG_CNT ( GR1553BC_IRQLOG_SIZE / sizeof( uint32_t ) )
/*** IRQ Flag Register ***/
#define GR1553B_IRQ_BCEV_BIT 0
#define GR1553B_IRQ_BCD_BIT 1
#define GR1553B_IRQ_BCWK_BIT 2
#define GR1553B_IRQ_RTEV_BIT 8
#define GR1553B_IRQ_RTD_BIT 9
#define GR1553B_IRQ_RTTE_BIT 10
#define GR1553B_IRQ_BMD_BIT 16
#define GR1553B_IRQ_BMTOF_BIT 17
#define GR1553B_IRQ_BCEV ( 1 << GR1553B_IRQ_BCEV_BIT )
#define GR1553B_IRQ_BCD ( 1 << GR1553B_IRQ_BCD_BIT )
#define GR1553B_IRQ_BCWK ( 1 << GR1553B_IRQ_BCWK_BIT )
#define GR1553B_IRQ_RTEV ( 1 << GR1553B_IRQ_RTEV_BIT )
#define GR1553B_IRQ_RTD ( 1 << GR1553B_IRQ_RTD_BIT )
#define GR1553B_IRQ_RTTE ( 1 << GR1553B_IRQ_RTTE_BIT )
#define GR1553B_IRQ_BMD ( 1 << GR1553B_IRQ_BMD_BIT )
#define GR1553B_IRQ_BMTOF ( 1 << GR1553B_IRQ_BMTOF_BIT )
/*** IRQ Enable Register ***/
#define GR1553B_IRQEN_BCEVE_BIT 0
#define GR1553B_IRQEN_BCDE_BIT 1
#define GR1553B_IRQEN_BCWKE_BIT 2
#define GR1553B_IRQEN_RTEVE_BIT 8
#define GR1553B_IRQEN_RTDE_BIT 9
#define GR1553B_IRQEN_RTTEE_BIT 10
#define GR1553B_IRQEN_BMDE_BIT 16
#define GR1553B_IRQEN_BMTOE_BIT 17
#define GR1553B_IRQEN_BCEVE ( 1 << GR1553B_IRQEN_BCEVE_BIT )
#define GR1553B_IRQEN_BCDE ( 1 << GR1553B_IRQEN_BCDE_BIT )
#define GR1553B_IRQEN_BCWKE ( 1 << GR1553B_IRQEN_BCWKE_BIT )
#define GR1553B_IRQEN_RTEVE ( 1 << GR1553B_IRQEN_RTEVE_BIT )
#define GR1553B_IRQEN_RTDE ( 1 << GR1553B_IRQEN_RTDE_BIT )
#define GR1553B_IRQEN_RTTEE ( 1 << GR1553B_IRQEN_RTTEE_BIT )
#define GR1553B_IRQEN_BMDE ( 1 << GR1553B_IRQEN_BMDE_BIT )
#define GR1553B_IRQEN_BMTOE ( 1 << GR1553B_IRQEN_BMTOE_BIT )
/*** BC Status Register ***/
#define GR1553B_BC_STAT_SCST_BIT 0
#define GR1553B_BC_STAT_SCADL_BIT 3
#define GR1553B_BC_STAT_ASST_BIT 8
#define GR1553B_BC_STAT_ASADL_BIT 11
#define GR1553B_BC_STAT_BCSUP_BIT 31
#define GR1553B_BC_STAT_SCST ( 0x3 << GR1553B_BC_STAT_SCST_BIT )
#define GR1553B_BC_STAT_SCADL ( 0x1f << GR1553B_BC_STAT_SCADL_BIT )
#define GR1553B_BC_STAT_ASST ( 0x3 << GR1553B_BC_STAT_ASST_BIT )
#define GR1553B_BC_STAT_ASADL ( 0x1f << GR1553B_BC_STAT_ASADL_BIT )
#define GR1553B_BC_STAT_BCSUP ( 1 << GR1553B_BC_STAT_BCSUP_BIT )
/*** BC Action Register ***/
#define GR1553B_BC_ACT_SCSRT_BIT 0
#define GR1553B_BC_ACT_SCSUS_BIT 1
#define GR1553B_BC_ACT_SCSTP_BIT 2
#define GR1553B_BC_ACT_SETT_BIT 3
#define GR1553B_BC_ACT_CLRT_BIT 4
#define GR1553B_BC_ACT_ASSRT_BIT 8
#define GR1553B_BC_ACT_ASSTP_BIT 9
#define GR1553B_BC_ACT_BCKEY_BIT 16
#define GR1553B_BC_ACT_SCSRT ( 1 << GR1553B_BC_ACT_SCSRT_BIT )
#define GR1553B_BC_ACT_SCSUS ( 1 << GR1553B_BC_ACT_SCSUS_BIT )
#define GR1553B_BC_ACT_SCSTP ( 1 << GR1553B_BC_ACT_SCSTP_BIT )
#define GR1553B_BC_ACT_SETT ( 1 << GR1553B_BC_ACT_SETT_BIT )
#define GR1553B_BC_ACT_CLRT ( 1 << GR1553B_BC_ACT_CLRT_BIT )
#define GR1553B_BC_ACT_ASSRT ( 1 << GR1553B_BC_ACT_ASSRT_BIT )
#define GR1553B_BC_ACT_ASSTP ( 1 << GR1553B_BC_ACT_ASSTP_BIT )
#define GR1553B_BC_ACT_BCKEY ( 0xffff << GR1553B_BC_ACT_BCKEY_BIT )
/*** BC Timer Register ***/
#define GR1553B_BC_TIMER_SCTM_BIT 0
#define GR1553B_BC_TIMER_SCTM ( 0xffffff << GR1553B_BC_TIMER_SCTM_BIT )
/*** BC Wake-up control Register ***/
#define GR1553B_BC_WAKE_TIME_BIT 0
#define GR1553B_BC_WAKE_WKEN_BIT 31
#define GR1553B_BC_WAKE_TIME ( 0xffffff << GR1553B_BC_WAKE_TIME_BIT )
#define GR1553B_BC_WAKE_WKEN ( 1 < GR1553B_BC_WAKE_WKEN_BIT )
/*** RT status Register ***/
#define GR1553B_RT_STAT_RUN_BIT 0
#define GR1553B_RT_STAT_SHDB_BIT 1
#define GR1553B_RT_STAT_SHDA_BIT 2
#define GR1553B_RT_STAT_ACT_BIT 3
#define GR1553B_RT_STAT_RTSUP_BIT 31
#define GR1553B_RT_STAT_RUN ( 1 << GR1553B_RT_STAT_RUN_BIT )
#define GR1553B_RT_STAT_SHDB ( 1 << GR1553B_RT_STAT_SHDB_BIT )
#define GR1553B_RT_STAT_SHDA ( 1 << GR1553B_RT_STAT_SHDA_BIT )
#define GR1553B_RT_STAT_ACT ( 1 << GR1553B_RT_STAT_ACT_BIT )
#define GR1553B_RT_STAT_RTSUP ( 1 << GR1553B_RT_STAT_RTSUP_BIT )
/*** RT Config Register ***/
#define GR1553B_RT_CFG_RTEN_BIT 0
#define GR1553B_RT_CFG_RTADDR_BIT 1
#define GR1553B_RT_CFG_RTKEY_BIT 16
#define GR1553B_RT_CFG_RTEN ( 1 << GR1553B_RT_CFG_RTEN_BIT )
#define GR1553B_RT_CFG_RTADDR ( 1 << GR1553B_RT_CFG_RTADDR_BIT )
#define GR1553B_RT_CFG_RTKEY ( 0xffff << GR1553B_RT_CFG_RTKEY_BIT )
/*** RT Bus Status Register ***/
#define GR1553B_RT_STAT2_TFLG_BIT 0
#define GR1553B_RT_STAT2_DBCA_BIT 1
#define GR1553B_RT_STAT2_SSF_BIT 2
#define GR1553B_RT_STAT2_BUSY_BIT 3
#define GR1553B_RT_STAT2_SREQ_BIT 4
#define GR1553B_RT_STAT2_TFDE_BIT 8
#define GR1553B_RT_STAT2_TFLG ( 1 << GR1553B_RT_STAT2_TFLG_BIT )
#define GR1553B_RT_STAT2_DBCA ( 1 << GR1553B_RT_STAT2_DBCA_BIT )
#define GR1553B_RT_STAT2_SSF ( 1 << GR1553B_RT_STAT2_SSF_BIT )
#define GR1553B_RT_STAT2_BUSY ( 1 << GR1553B_RT_STAT2_BUSY_BIT )
#define GR1553B_RT_STAT2_SREQ ( 1 << GR1553B_RT_STAT2_SREQ_BIT )
#define GR1553B_RT_STAT2_TFDE ( 1 << GR1553B_RT_STAT2_TFDE_BIT )
/*** RT Status Words Register ***/
#define GR1553B_RT_STATW_VECW_BIT 0
#define GR1553B_RT_STATW_BITW_BIT 16
#define GR1553B_RT_STATW_VECW ( 0xffff << GR1553B_RT_STATW_VECW_BIT )
#define GR1553B_RT_STATW_BITW ( 0xffff << GR1553B_RT_STATW_BITW_BIT )
/*** RT Sync Register ***/
#define GR1553B_RT_SYNC_SYD_BIT 0
#define GR1553B_RT_SYNC_SYTM_BIT 16
#define GR1553B_RT_SYNC_SYD ( 0xffff << GR1553B_RT_SYNC_SYD_BIT )
#define GR1553B_RT_SYNC_SYTM ( 0xffff << GR1553B_RT_SYNC_SYTM_BIT )
/*** RT Sub adress table Register ***/
#define GR1553B_RT_TAB_SATB_BIT 0
#define GR1553B_RT_TAB_SATB ( 0xffff << GR1553B_RT_TAB_SATB_BIT )
/*** RT Mode code control Register ***/
#define GR1553B_RT_MCCTRL_S_BIT 0
#define GR1553B_RT_MCCTRL_SB_BIT 2
#define GR1553B_RT_MCCTRL_SD_BIT 4
#define GR1553B_RT_MCCTRL_SDB_BIT 6
#define GR1553B_RT_MCCTRL_TS_BIT 8
#define GR1553B_RT_MCCTRL_TSB_BIT 10
#define GR1553B_RT_MCCTRL_TVW_BIT 12
#define GR1553B_RT_MCCTRL_TBW_BIT 14
#define GR1553B_RT_MCCTRL_DBC_BIT 16
#define GR1553B_RT_MCCTRL_IST_BIT 18
#define GR1553B_RT_MCCTRL_ISTB_BIT 20
#define GR1553B_RT_MCCTRL_ITF_BIT 22
#define GR1553B_RT_MCCTRL_ITFB_BIT 24
#define GR1553B_RT_MCCTRL_RRT_BIT 26
#define GR1553B_RT_MCCTRL_RRTB_BIT 28
#define GR1553B_RT_MCCTRL_S ( 1 << GR1553B_RT_MCCTRL_S_BIT )
#define GR1553B_RT_MCCTRL_SB ( 1 << GR1553B_RT_MCCTRL_SB_BIT )
#define GR1553B_RT_MCCTRL_SD ( 1 << GR1553B_RT_MCCTRL_SD_BIT )
#define GR1553B_RT_MCCTRL_SDB ( 1 << GR1553B_RT_MCCTRL_SDB_BIT )
#define GR1553B_RT_MCCTRL_TS ( 1 << GR1553B_RT_MCCTRL_TS_BIT )
#define GR1553B_RT_MCCTRL_TSB ( 1 << GR1553B_RT_MCCTRL_TSB_BIT )
#define GR1553B_RT_MCCTRL_TVW ( 1 << GR1553B_RT_MCCTRL_TVW_BIT )
#define GR1553B_RT_MCCTRL_TBW ( 1 << GR1553B_RT_MCCTRL_TBW_BIT )
#define GR1553B_RT_MCCTRL_DBC ( 1 << GR1553B_RT_MCCTRL_DBC_BIT )
#define GR1553B_RT_MCCTRL_IST ( 1 << GR1553B_RT_MCCTRL_IST_BIT )
#define GR1553B_RT_MCCTRL_ISTB ( 1 << GR1553B_RT_MCCTRL_ISTB_BIT )
#define GR1553B_RT_MCCTRL_ITF ( 1 << GR1553B_RT_MCCTRL_ITF_BIT )
#define GR1553B_RT_MCCTRL_ITFB ( 1 << GR1553B_RT_MCCTRL_ITFB_BIT )
#define GR1553B_RT_MCCTRL_RRT ( 1 << GR1553B_RT_MCCTRL_RRT_BIT )
#define GR1553B_RT_MCCTRL_RRTB ( 1 << GR1553B_RT_MCCTRL_RRTB_BIT )
/*** RT Time Tag control Register ***/
#define GR1553B_RT_TTAG_TVAL_BIT 0
#define GR1553B_RT_TTAG_TRES_BIT 16
#define GR1553B_RT_TTAG_TVAL ( 0xffff << GR1553B_RT_TTAG_TVAL_BIT )
#define GR1553B_RT_TTAG_TRES ( 0xffff << GR1553B_RT_TTAG_TRES_BIT )
/*** BM Control Register ***/
#define GR1553B_BM_STAT_BMSUP_BIT 31
#define GR1553B_BM_STAT_BMSUP ( 1 << GR1553B_BM_STAT_BMSUP_BIT )
/*** BM Control Register ***/
#define GR1553B_BM_CTRL_BMEN_BIT 0
#define GR1553B_BM_CTRL_MANL_BIT 1
#define GR1553B_BM_CTRL_UDWL_BIT 2
#define GR1553B_BM_CTRL_IMCL_BIT 3
#define GR1553B_BM_CTRL_BMEN ( 1 << GR1553B_BM_CTRL_BMEN_BIT )
#define GR1553B_BM_CTRL_MANL ( 1 << GR1553B_BM_CTRL_MANL_BIT )
#define GR1553B_BM_CTRL_UDWL ( 1 << GR1553B_BM_CTRL_UDWL_BIT )
#define GR1553B_BM_CTRL_IMCL ( 1 << GR1553B_BM_CTRL_IMCL_BIT )
/*** BM RT Mode code filter Register ***/
#define GR1553B_BM_MC_S_BIT 0
#define GR1553B_BM_MC_SB_BIT 1
#define GR1553B_BM_MC_SD_BIT 2
#define GR1553B_BM_MC_SDB_BIT 3
#define GR1553B_BM_MC_TS_BIT 4
#define GR1553B_BM_MC_TSB_BIT 5
#define GR1553B_BM_MC_TVW_BIT 6
#define GR1553B_BM_MC_TBW_BIT 7
#define GR1553B_BM_MC_DBC_BIT 8
#define GR1553B_BM_MC_IST_BIT 9
#define GR1553B_BM_MC_ISTB_BIT 10
#define GR1553B_BM_MC_ITF_BIT 11
#define GR1553B_BM_MC_ITFB_BIT 12
#define GR1553B_BM_MC_RRT_BIT 13
#define GR1553B_BM_MC_RRTB_BIT 14
#define GR1553B_BM_MC_TSW_BIT 15
#define GR1553B_BM_MC_TLC_BIT 16
#define GR1553B_BM_MC_STS_BIT 17
#define GR1553B_BM_MC_STSB_BIT 18
#define GR1553B_BM_MC_S ( 1 << GR1553B_BM_MC_S_BIT )
#define GR1553B_BM_MC_SB ( 1 << GR1553B_BM_MC_SB_BIT )
#define GR1553B_BM_MC_SD ( 1 << GR1553B_BM_MC_SD_BIT )
#define GR1553B_BM_MC_SDB ( 1 << GR1553B_BM_MC_SDB_BIT )
#define GR1553B_BM_MC_TS ( 1 << GR1553B_BM_MC_TS_BIT )
#define GR1553B_BM_MC_TSB ( 1 << GR1553B_BM_MC_TSB_BIT )
#define GR1553B_BM_MC_TVW ( 1 << GR1553B_BM_MC_TVW_BIT )
#define GR1553B_BM_MC_TBW ( 1 << GR1553B_BM_MC_TBW_BIT )
#define GR1553B_BM_MC_DBC ( 1 << GR1553B_BM_MC_DBC_BIT )
#define GR1553B_BM_MC_IST ( 1 << GR1553B_BM_MC_IST_BIT )
#define GR1553B_BM_MC_ISTB ( 1 << GR1553B_BM_MC_ISTB_BIT )
#define GR1553B_BM_MC_ITF ( 1 << GR1553B_BM_MC_ITF_BIT )
#define GR1553B_BM_MC_ITFB ( 1 << GR1553B_BM_MC_ITFB_BIT )
#define GR1553B_BM_MC_RRT ( 1 << GR1553B_BM_MC_RRT_BIT )
#define GR1553B_BM_MC_RRTB ( 1 << GR1553B_BM_MC_RRTB_BIT )
#define GR1553B_BM_MC_TSW ( 1 << GR1553B_BM_MC_TSW_BIT )
#define GR1553B_BM_MC_TLC ( 1 << GR1553B_BM_MC_TLC_BIT )
#define GR1553B_BM_MC_STS ( 1 << GR1553B_BM_MC_STS_BIT )
#define GR1553B_BM_MC_STSB ( 1 << GR1553B_BM_MC_STSB_BIT )
/*** BM RT Mode code filter Register ***/
#define GR1553B_BM_TTAG_VAL_BIT 0
#define GR1553B_BM_TTAG_RES_BIT 24
#define GR1553B_BM_TTAG_VAL ( 0xffffff << GR1553B_BM_TTAG_VAL_BIT )
#define GR1553B_BM_TTAG_RES ( 0xff << GR1553B_BM_TTAG_RES_BIT )
/* Register GR1553B driver */
extern void gr1553_register( void );
/*** BC Device allocation ***/
/* Allocate a BC device. Minor is assigned to a device in the order
* they are registered to the driver.
*/
extern struct drvmgr_dev **gr1553_bc_open( int minor );
/* Free a BC device previously allocated */
extern void gr1553_bc_close( struct drvmgr_dev **dev );
/*** RT Device allocation ***/
/* Allocate a BC device. Minor is assigned to a device in the order
* they are registered to the driver.
*/
extern struct drvmgr_dev **gr1553_rt_open( int minor );
/* Free a BC device previously allocated */
extern void gr1553_rt_close( struct drvmgr_dev **dev );
/*** BM Device allocation ***/
/* Allocate a BC device. Minor is assigned to a device in the order
* they are registered to the driver.
*/
extern struct drvmgr_dev **gr1553_bm_open( int minor );
/* Free a BC device previously allocated */
extern void gr1553_bm_close( struct drvmgr_dev **dev );
#ifdef __cplusplus
}
#endif
#endif /* __GR1553B_H__ */