RTEMS  5.0.0
Macros | Typedefs
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "alt_hwlibs_ver.h"

Go to the source code of this file.

Macros

#define ALT_E_SUCCESS   0
 
#define ALT_E_ERROR   (-1)
 
#define ALT_E_FPGA_CFG   (-2)
 
#define ALT_E_FPGA_CRC   (-3)
 
#define ALT_E_FPGA_CFG_STM   (-4)
 
#define ALT_E_FPGA_PWR_OFF   (-5)
 
#define ALT_E_FPGA_NO_SOC_CTRL   (-6)
 
#define ALT_E_FPGA_NOT_USER_MODE   (-7)
 
#define ALT_E_ARG_RANGE   (-8)
 
#define ALT_E_BAD_ARG   (-9)
 
#define ALT_E_BAD_OPERATION   (-10)
 
#define ALT_E_INV_OPTION   (-11)
 
#define ALT_E_TMO   (-12)
 
#define ALT_E_RESERVED   (-13)
 
#define ALT_E_BAD_CLK   (-14)
 
#define ALT_E_BAD_VERSION   (-15)
 
#define ALT_E_BUF_OVF   (-20)
 
#define ALT_E_FALSE   (0)
 
#define ALT_E_TRUE   (1)
 
#define ALT_HWLIBS_VERSION(a, b, c)   (((a)*10000)+((b)*100)+(c))
 
#define ALTERA_HWLIBS_VERSION_CODE
 
#define ALTERA_INTERNAL_ONLY_DOCS   1
 
#define ALT_HPS_ADDR   0
 
#define ALT_MILLISECS_IN_A_SEC   1000
 
#define ALT_MICROSECS_IN_A_SEC   1000000
 
#define ALT_NANOSECS_IN_A_SEC   1000000000
 
#define ALT_TWO_TO_POW0   (1)
 
#define ALT_TWO_TO_POW1   (1<<1)
 
#define ALT_TWO_TO_POW2   (1<<2)
 
#define ALT_TWO_TO_POW3   (1<<3)
 
#define ALT_TWO_TO_POW4   (1<<4)
 
#define ALT_TWO_TO_POW5   (1<<5)
 
#define ALT_TWO_TO_POW6   (1<<6)
 
#define ALT_TWO_TO_POW7   (1<<7)
 
#define ALT_TWO_TO_POW8   (1<<8)
 
#define ALT_TWO_TO_POW9   (1<<9)
 
#define ALT_TWO_TO_POW10   (1<<10)
 
#define ALT_TWO_TO_POW11   (1<<11)
 
#define ALT_TWO_TO_POW12   (1<<12)
 
#define ALT_TWO_TO_POW13   (1<<13)
 
#define ALT_TWO_TO_POW14   (1<<14)
 
#define ALT_TWO_TO_POW15   (1<<15)
 
#define ALT_TWO_TO_POW16   (1<<16)
 
#define ALT_TWO_TO_POW17   (1<<17)
 
#define ALT_TWO_TO_POW18   (1<<18)
 
#define ALT_TWO_TO_POW19   (1<<19)
 
#define ALT_TWO_TO_POW20   (1<<20)
 
#define ALT_TWO_TO_POW21   (1<<21)
 
#define ALT_TWO_TO_POW22   (1<<22)
 
#define ALT_TWO_TO_POW23   (1<<23)
 
#define ALT_TWO_TO_POW24   (1<<24)
 
#define ALT_TWO_TO_POW25   (1<<25)
 
#define ALT_TWO_TO_POW26   (1<<26)
 
#define ALT_TWO_TO_POW27   (1<<27)
 
#define ALT_TWO_TO_POW28   (1<<28)
 
#define ALT_TWO_TO_POW29   (1<<29)
 
#define ALT_TWO_TO_POW30   (1<<30)
 
#define ALT_TWO_TO_POW31   (1<<31)
 

Typedefs

typedef int32_t ALT_STATUS_CODE
 

Macro Definition Documentation

◆ ALT_E_ARG_RANGE

#define ALT_E_ARG_RANGE   (-8)

An argument violates a range constraint.

◆ ALT_E_BAD_ARG

#define ALT_E_BAD_ARG   (-9)

A bad argument value was passed.

◆ ALT_E_BAD_CLK

#define ALT_E_BAD_CLK   (-14)

A clock is not enabled or violates an operational constraint.

◆ ALT_E_BAD_OPERATION

#define ALT_E_BAD_OPERATION   (-10)

The operation is invalid or illegal.

◆ ALT_E_BAD_VERSION

#define ALT_E_BAD_VERSION   (-15)

The version ID is invalid.

◆ ALT_E_BUF_OVF

#define ALT_E_BUF_OVF   (-20)

The buffer does not contain enough free space for the operation.

◆ ALT_E_ERROR

#define ALT_E_ERROR   (-1)

The operation failed.

◆ ALT_E_FALSE

#define ALT_E_FALSE   (0)

Indicates a FALSE condition.

◆ ALT_E_FPGA_CFG

#define ALT_E_FPGA_CFG   (-2)

FPGA configuration error detected.

◆ ALT_E_FPGA_CFG_STM

#define ALT_E_FPGA_CFG_STM   (-4)

An error occurred on the FPGA configuration bitstream input source.

◆ ALT_E_FPGA_CRC

#define ALT_E_FPGA_CRC   (-3)

FPGA CRC error detected.

◆ ALT_E_FPGA_NO_SOC_CTRL

#define ALT_E_FPGA_NO_SOC_CTRL   (-6)

The SoC does not currently control the FPGA.

◆ ALT_E_FPGA_NOT_USER_MODE

#define ALT_E_FPGA_NOT_USER_MODE   (-7)

The FPGA is not in USER mode.

◆ ALT_E_FPGA_PWR_OFF

#define ALT_E_FPGA_PWR_OFF   (-5)

The FPGA is powered off.

◆ ALT_E_INV_OPTION

#define ALT_E_INV_OPTION   (-11)

An invalid option was selected.

◆ ALT_E_RESERVED

#define ALT_E_RESERVED   (-13)

The argument value is reserved or unavailable.

◆ ALT_E_SUCCESS

#define ALT_E_SUCCESS   0

Definitions of status codes returned by the HWLIB.

The operation was successful.

◆ ALT_E_TMO

#define ALT_E_TMO   (-12)

An operation or response timeout period expired.

◆ ALT_E_TRUE

#define ALT_E_TRUE   (1)

Indicates a TRUE condition.

◆ ALT_HPS_ADDR

#define ALT_HPS_ADDR   0

Provide base address of MPU address space

◆ ALT_HWLIBS_VERSION

#define ALT_HWLIBS_VERSION (   a,
  b,
 
)    (((a)*10000)+((b)*100)+(c))

Specifies the current major and minor revision of the HWLibs. The MS four decimal digits specify the Altera ACDS release number, the LS two decimal digits specify minor revisions of the HWLibs, if any.

A typical use is:

#if ALTERA_HWLIBS_VERSION_CODE >= ALT_HWLIBS_VERSION(13, 1, 0)

for a dependency on the major or minor ACDS revision or

#if ALTERA_HWLIBS_VERSION_CODE == ALT_HWLIBS_VERSION(13, 0, 12)

for a dependency on the hwlibs revision

◆ ALT_MILLISECS_IN_A_SEC

#define ALT_MILLISECS_IN_A_SEC   1000

These constants are sometimes useful:

◆ ALTERA_HWLIBS_VERSION_CODE

#define ALTERA_HWLIBS_VERSION_CODE
Value:
ALT_HWLIBS_VERSION(ALTERA_ACDS_MAJOR_REV, \
ALTERA_ACDS_MINOR_REV, ALTERA_HWLIBS_REV)
#define ALT_HWLIBS_VERSION(a, b, c)
Definition: hwlib.h:132

◆ ALTERA_INTERNAL_ONLY_DOCS

#define ALTERA_INTERNAL_ONLY_DOCS   1

Allow some parts of the documentation to be hidden by setting to zero

Typedef Documentation

◆ ALT_STATUS_CODE

typedef int32_t ALT_STATUS_CODE

The type definition for status codes returned by the HWLIB.