syscon_api.h

MIPS YAMON, a famous monitor inc. source, make file and PDF manuals.

    /* IIC */
    SYSCON_COM_IIC_BAUDRATE_ID = 175,                /* UINT8         */
    SYSCON_COM_PIIX4_IIC_BIGEND_ID = 176,            /* bool          */

    /* Environment variables */
    SYSCON_DISK_ENVIRONMENT_ID = 177,       /* t_user_environment_var */

    /* System error handling services */
    SYSCON_ERROR_REGISTER_LOOKUP_ID = 178,     /* t_sys_error_lookup_registration */
    SYSCON_ERROR_LOOKUP_ID = 179,              /* t_sys_error_lookup  */

    /* File transfer */
    SYSCON_FILE_BATCH_ACCESS_ID = 180, /* t_sys_batch_file_descriptor */
    SYSCON_FILE_BOOTSERVER_ID = 181,                 /* UINT32        */

    /**********************************************************************
     * Below IDs are available in YAMON revision 02.01 and later revisions
     **********************************************************************/

    /* Secondary cache */
    SYSCON_CPU_SCACHE_SIZE_CURRENT_ID = 182,         /* UINT32        */
    SYSCON_CPU_SCACHE_LINESIZE_CURRENT_ID = 183,     /* UINT32        */
    SYSCON_CPU_SCACHE_ASSOC_CURRENT_ID = 184,        /* UINT32        */

    /* PCI memory mapping */
    SYSCON_CORE_PCI_MEM_START = 185,                 /* UINT32        */
    SYSCON_CORE_PCI_MEM_SIZE = 186,                  /* UINT32        */
    SYSCON_CORE_PCI_MEM_OFFSET = 187,                /* UINT32        */
    SYSCON_CORE_PCI_IO_START = 188,                  /* UINT32        */
    SYSCON_CORE_PCI_IO_SIZE = 189,                   /* UINT32        */
    SYSCON_CORE_PCI_IO_OFFSET = 190,                 /* UINT32        */

    /* EEPROM definitions */
    SYSCON_BOARD_EEPROM_COUNT_ID = 191,              /* UINT8         */
    SYSCON_BOARD_EEPROM_DEF_ID = 192,         /* t_syscon_eeprom_def* */

    /* Number of UARTs on board */
    SYSCON_BOARD_UART_COUNT_ID = 193,                /* UINT8         */

    /**********************************************************************
     * Below IDs are available in YAMON revision 02.03 and later revisions
     **********************************************************************/

    SYSCON_SYSCTRL_NAME_ID = 194,                    /* char *        */
    SYSCON_SYSCTRL_REV_ID = 195,                     /* char *        */
    SYSCON_SYSCTRL_SYSID_ID = 196,                   /* UINT32        */
    SYSCON_SYSCTRL_PBCREV_MAJOR_ID = 197,            /* UINT32        */
    SYSCON_SYSCTRL_PBCREV_MINOR_ID = 198,            /* UINT32        */
    SYSCON_SYSCTRL_PCIREV_MAJOR_ID = 199,            /* UINT32        */
    SYSCON_SYSCTRL_PCIREV_MINOR_ID = 200,            /* UINT32        */
    SYSCON_SYSCTRL_WC_CFG_ID = 201,                  /* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_DDR_CFG_ID = 202,         /* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_CSLAT_CYCLES_CFG_ID = 203,/* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_WRLAT_CYCLES_CFG_ID = 204,/* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_RDDEL_CYCLES_CFG_ID = 205,/* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_FW_CFG_ID = 206,          /* UINT32        */
    SYSCON_BOARD_SYSTEMRAM_CLKRAT_CFG_ID = 207,      /* char *        */
    SYSCON_BOARD_SYSTEMRAM_PARITY_CFG_ID = 208,      /* UINT32        */
    SYSCON_SYSCTRL_REGADDR_BASE_ID = 209,            /* UINT32        */
    SYSCON_BOARD_NMI_ACK_ID = 210,                   /* bool          */
    SYSCON_BOARD_PCI_ALLOC_ERR_ID = 211,             /* bool          */

    /* More CP0 registers */
    SYSCON_CPU_CP0_PAGEGRAIN_ID = 212,		     /* UINT32	      */
    SYSCON_CPU_CP0_HWRENA_ID = 213,		     /* UINT32	      */
    SYSCON_CPU_CP0_EBASE_ID = 214,		     /* UINT32	      */
    SYSCON_CPU_CP0_CONFIG2_ID = 215,		     /* UINT32	      */
    SYSCON_CPU_CP0_CONFIG3_ID = 216,		     /* UINT32	      */
    SYSCON_CPU_CP0_XCONTEXT_ID = 217,		     /* UINT32/UINT64 */
    SYSCON_CPU_CP0_TRACECONTROL_ID = 218,	     /* UINT32	      */
    SYSCON_CPU_CP0_TRACECONTROL2_ID = 219,	     /* UINT32	      */
    SYSCON_CPU_CP0_USERTRACEDATA_ID = 220,	     /* UINT32	      */
    SYSCON_CPU_CP0_TRACEBPC_ID = 221,		     /* UINT32	      */
    SYSCON_CPU_CP0_PERFCOUNT_COUNT0_ID = 222,	     /* UINT32	      */
    SYSCON_CPU_CP0_PERFCOUNT_CTRL1_ID = 223,	     /* UINT32	      */
    SYSCON_CPU_CP0_PERFCOUNT_COUNT1_ID = 224,	     /* UINT32	      */
    SYSCON_CPU_CP0_PERFCOUNT_CTRL2_ID = 225,	     /* UINT32	      */
    SYSCON_CPU_CP0_PERFCOUNT_COUNT2_ID = 226,	     /* UINT32	      */
    SYSCON_CPU_CP0_DERRCTL_ID = 227,		     /* UINT32	      */
    SYSCON_CPU_CP0_IERRCTL_ID = 228,		     /* UINT32	      */
    SYSCON_CPU_CP0_ITAGLO_ID = 229,		     /* UINT32	      */
    SYSCON_CPU_CP0_IDATALO_ID = 230,		     /* UINT32	      */
    SYSCON_CPU_CP0_DTAGLO_ID = 231,		     /* UINT32	      */
    SYSCON_CPU_CP0_DDATALO_ID = 232,		     /* UINT32	      */
    SYSCON_CPU_CP0_ITAGHI_ID = 233,		     /* UINT32	      */
    SYSCON_CPU_CP0_IDATAHI_ID = 234,		     /* UINT32	      */
    SYSCON_CPU_CP0_DTAGHI_ID = 235,		     /* UINT32	      */
    SYSCON_CPU_CP0_DDATAHI_ID = 236,		     /* UINT32	      */
    SYSCON_CPU_CP0_INTCTL_ID = 237,		     /* UINT32	      */
    SYSCON_CPU_CP0_SRSCTL_ID = 238,		     /* UINT32	      */
    SYSCON_CPU_CP0_SRSMAP_ID = 239,		     /* UINT32	      */
    SYSCON_CPU_CP0_L23TAGLO_ID = 240,		     /* UINT32/UINT64 */
    SYSCON_CPU_CP0_L23DATALO_ID = 241,		     /* UINT32/UINT64 */
    SYSCON_CPU_CP0_L23TAGHI_ID = 242,		     /* UINT32/UINT64 */
    SYSCON_CPU_CP0_L23DATAHI_ID = 243,		     /* UINT32/UINT64 */

    /**********************************************************************
     * Below IDs are available in YAMON revision 02.05 and later revisions
     **********************************************************************/
    SYSCON_CPU_CP0_IWATCHLO0_ID = 244,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_IWATCHHI0_ID = 245,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_IWATCHLO1_ID = 246,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_IWATCHHI1_ID = 247,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_DWATCHLO0_ID = 248,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_DWATCHHI0_ID = 249,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_DWATCHLO1_ID = 250,               /* UINT32/UINT64 */
    SYSCON_CPU_CP0_DWATCHHI1_ID = 251                /* UINT32/UINT64 */

    /* More CP0 registers */


    /**********************************************************************
     * Insert new IDs below. Remember to update SYSCON_OBJ_COUNT !!!
     **********************************************************************/
}
t_syscon_ids;

#define SYSCON_OBJ_COUNT   (SYSCON_CPU_CP0_DWATCHHI1_ID + 1)

/************************************************************************
 *    Public variables
 ************************************************************************/

/************************************************************************
 *   Public functions
 ************************************************************************/


/************************************************************************
 *
 *                          SYSCON_init
 *  Description :
 *  -------------
 *
 *  Initializes the 'syscon' module.
 *  
 *  Parameters :
 *  ------------
 *
 *  None
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0)
 *
 ************************************************************************/
INT32 
SYSCON_init( void );


/************************************************************************
 *
 *                          SYSCON_read
 *  Description :
 *  -------------
 *
 *  Read the value of system configuration object given by 'id'.
 *
 *  Parameters :
 *  ------------
 *
 *  'id',           IN,    Object id.
 *  'param',        INOUT, Buffer for object value.
 *  'param_size',   IN,    Size of buffer (must match size of object).
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0), returned parameter value and size are valid.
 *  'ERROR_SYSCON_UNKNOWN_PARAM': parameter not available on this board
 *  'ERROR_SYSCON_SIZE_MISMATCH': parameter size check failed
 *
 ************************************************************************/
INT32 
SYSCON_read(
    t_syscon_ids  id,		/* IN: object ID			*/
    void          *param,       /* IN: Buffer for object value		*/
    UINT32	  param_size);  /* IN: Buffer size (bytes)		*/


/************************************************************************
 *
 *                          SYSCON_write
 *  Description :
 *  -------------
 *
 *  Write the system configuration object given by 'id'.
 *
 *  Parameters :
 *  ------------
 *
 *  'id',         IN,    Object id.
 *  'param',      IN,    Buffer containing value to write.
 *  'param_size', IN,    Size of buffer.
 *
 *  Return values :
 *  ---------------
 *
 *  'OK'(=0), parameter value has been set
 *  'ERROR_SYSCON_UNKNOWN_PARAM': parameter not available on this board
 *  'ERROR_SYSCON_SIZE_MISMATCH': parameter size check failed
 *
 ************************************************************************/
INT32 
SYSCON_write(
    t_syscon_ids  id,		/* IN: object ID			*/
    void          *param,       /* IN: Buffer with value		*/
    UINT32	  param_size);  /* IN: Size of buffer (bytes)		*/


#endif /* #ifndef SYSCON_API_H */