TwiceAsNice  2019-02-18
Macros | Enumerations
gsc_common.h File Reference
#include "gsc_types.h"
Include dependency graph for gsc_common.h:
This graph shows which files directly or indirectly include this file:

Macros

#define GSC_PROCESS_OPEN_MAX   8
 
#define GSC_NO_CHANGE   0xFFFFFFFFUL
 
#define GSC_DEFAULT   0xFFFFFFFEUL
 
#define GSC_IO_STATUS_TX   0x80000000
 
#define GSC_IO_STATUS_MASK   0x70000000 /* Current status */
 
#define GSC_IO_STATUS_COUNT_MASK   0x0FFFFFFF /* 256MB */
 
#define GSC_IO_STATUS_ERROR   0x40000000 /* 4 */
 
#define GSC_IO_STATUS_ABORTED   0x30000000 /* 3 */
 
#define GSC_IO_STATUS_TIMEOUT   0x20000000 /* 2 */
 
#define GSC_IO_STATUS_ACTIVE   0x10000000 /* 1 */
 
#define GSC_IO_STATUS_SUCCESS   0x00000000 /* 0 */
 
#define GSC_REG_PCI   0x8000
 
#define GSC_REG_PLX   0x4000
 
#define GSC_REG_PLDA   0x4000
 
#define GSC_REG_GSC   0x0000
 
#define GSC_FIELD_DECODE(r, b, e)   (((r)>>(e)) & (0xFFFFFFFFUL >> (31-((b)-(e)))))
 
#define GSC_FIELD_ENCODE(v, b, e)   (((v) << (e)) & ((~0UL << (e)) & (~0UL >> (31 - (b)))))
 
#define GSC_REG_ENCODE(t, s, o)
 
#define GSC_REG_OFFSET(r)   GSC_FIELD_DECODE((r),11,0)
 
#define GSC_REG_SIZE(r)   (GSC_FIELD_DECODE((r),13,12) + 1)
 
#define GSC_REG_TYPE(r)   ((r) & 0xC000)
 
#define GSC_VERSION_LIBRARY   0 /* API Library Version */
 
#define GSC_VERSION_DRIVER   1 /* Device Driver Version */
 

Enumerations

enum  gsc_status_t {
  GSC_SUCCESS = 0x200, GSC_FAILED, GSC_ACCESS_DENIED, GSC_DMA_CHANNEL_UNAVAILABLE,
  GSC_DMA_CHANNEL_INVALID, GSC_DMA_CHANNEL_TYPE_ERROR, GSC_DMA_IN_PROGRESS, GSC_DMA_DONE,
  GSC_DMA_PAUSED, GSC_DMA_NOT_PAUSED, GSC_DMA_CHANNEL_COMMAND_INVALID, GSC_DMA_MAN_READY,
  GSC_DMA_MAN_NOT_READY, GSC_DMA_INVALID_CHANNEL_PRIORITY, GSC_DMA_MAN_CORRUPTED, GSC_DMA_INVALID_ELEMENT_INDEX,
  GSC_DMA_NO_MORE_ELEMENTS, GSC_DMA_SGL_INVALID, GSC_DMA_SGL_QUEUE_FULL, GSC_NULL_PARAM,
  GSC_INVALID_BUS_INDEX, GSC_UNSUPPORTED_FUNCTION, GSC_INVALID_PCI_SPACE, GSC_INVALID_IOP_SPACE,
  GSC_INVALID_SIZE, GSC_INVALID_ADDRESS, GSC_INVALID_ADDRESS_TYPE, GSC_INVALID_INDEX,
  GSC_MU_NOT_READY, GSC_MU_FIFO_EMPTY, GSC_MU_FIFO_FULL, GSC_INVALID_REGISTER,
  GSC_DOORBELL_CLEAR_FAILED, GSC_INVALID_USER_PIN, GSC_INVALID_USER_STATE, GSC_EEPROM_NOT_PRESENT,
  GSC_EEPROMP_TYPE_NOT_SUPPORTED, GSC_EEPROM_BLANK, GSC_CONFIG_ACCESS_FAILED, GSC_INVALID_DEVICE_INFO,
  GSC_NO_ACTIVE_DRIVER, GSC_INSUFFICIENT_RESOURCES, GSC_OBJECT_ALREADY_ALLOCATED, GSC_ALREADY_INITIALIZED,
  GSC_NOT_INITIALIZED, GSC_BAD_CONFIG_REG_ENDIAN_MODE, GSC_INVALID_POWER_STATE, GSC_POWER_DOWN,
  GSC_FLYBY_NOT_SUPPORTED, GSC_CHANNEL_NOT_SUPPORTED, GSC_NO_ACTION, GSC_HS_NOT_SUPPORTED,
  GSC_VP_NOT_SUPPORTED, GSC_VPD_NOT_ENABLED, GSC_NO_MORE_CAP, GSC_INVALID_OFFSET,
  GSC_BAD_PIN_DIRECTION, GSC_PCI_TIMEOUT, GSC_DMA_CHANNEL_CLOSED, GSC_DMA_CHANNEL_ERROR,
  GSC_INVALID_HANDLE, GSC_BUFFER_NOT_READY, GSC_INVALID_DATA, GSC_DO_NOTHING,
  GSC_DMA_SGL_BUILD_FAILED, GSC_PM_NOT_SUPPORTED, GSC_INVALID_VERSION_DRIVER, GSC_WAIT_TIMEOUT,
  GSC_WAIT_CANCELED, GSC_LIB_LOAD_FAILURE = 0x800, GSC_RESERVED2, GSC_INIT_FAILURE,
  GSC_INVALID_VERSION_API, GSC_RESERVED, GSC_INTERNAL_ERROR, GSC_TOO_MANY_OPEN_HANDLES,
  GSC_INVALID_API_HANDLE, GSC_THREAD_FAILURE, GSC_ABORTED, GSC_SUCCESS = 0x200,
  GSC_FAILED, GSC_ACCESS_DENIED, GSC_DMA_CHANNEL_UNAVAILABLE, GSC_DMA_CHANNEL_INVALID,
  GSC_DMA_CHANNEL_TYPE_ERROR, GSC_DMA_IN_PROGRESS, GSC_DMA_DONE, GSC_DMA_PAUSED,
  GSC_DMA_NOT_PAUSED, GSC_DMA_CHANNEL_COMMAND_INVALID, GSC_DMA_MAN_READY, GSC_DMA_MAN_NOT_READY,
  GSC_DMA_INVALID_CHANNEL_PRIORITY, GSC_DMA_MAN_CORRUPTED, GSC_DMA_INVALID_ELEMENT_INDEX, GSC_DMA_NO_MORE_ELEMENTS,
  GSC_DMA_SGL_INVALID, GSC_DMA_SGL_QUEUE_FULL, GSC_NULL_PARAM, GSC_INVALID_BUS_INDEX,
  GSC_UNSUPPORTED_FUNCTION, GSC_INVALID_PCI_SPACE, GSC_INVALID_IOP_SPACE, GSC_INVALID_SIZE,
  GSC_INVALID_ADDRESS, GSC_INVALID_ADDRESS_TYPE, GSC_INVALID_INDEX, GSC_MU_NOT_READY,
  GSC_MU_FIFO_EMPTY, GSC_MU_FIFO_FULL, GSC_INVALID_REGISTER, GSC_DOORBELL_CLEAR_FAILED,
  GSC_INVALID_USER_PIN, GSC_INVALID_USER_STATE, GSC_EEPROM_NOT_PRESENT, GSC_EEPROMP_TYPE_NOT_SUPPORTED,
  GSC_EEPROM_BLANK, GSC_CONFIG_ACCESS_FAILED, GSC_INVALID_DEVICE_INFO, GSC_NO_ACTIVE_DRIVER,
  GSC_INSUFFICIENT_RESOURCES, GSC_OBJECT_ALREADY_ALLOCATED, GSC_ALREADY_INITIALIZED, GSC_NOT_INITIALIZED,
  GSC_BAD_CONFIG_REG_ENDIAN_MODE, GSC_INVALID_POWER_STATE, GSC_POWER_DOWN, GSC_FLYBY_NOT_SUPPORTED,
  GSC_CHANNEL_NOT_SUPPORTED, GSC_NO_ACTION, GSC_HS_NOT_SUPPORTED, GSC_VP_NOT_SUPPORTED,
  GSC_VPD_NOT_ENABLED, GSC_NO_MORE_CAP, GSC_INVALID_OFFSET, GSC_BAD_PIN_DIRECTION,
  GSC_PCI_TIMEOUT, GSC_DMA_CHANNEL_CLOSED, GSC_DMA_CHANNEL_ERROR, GSC_INVALID_HANDLE,
  GSC_BUFFER_NOT_READY, GSC_INVALID_DATA, GSC_DO_NOTHING, GSC_DMA_SGL_BUILD_FAILED,
  GSC_PM_NOT_SUPPORTED, GSC_INVALID_VERSION_DRIVER, GSC_WAIT_TIMEOUT, GSC_WAIT_CANCELED,
  GSC_LIB_LOAD_FAILURE = 0x800, GSC_RESERVED2, GSC_INIT_FAILURE, GSC_INVALID_VERSION_API,
  GSC_RESERVED, GSC_INTERNAL_ERROR, GSC_TOO_MANY_OPEN_HANDLES, GSC_INVALID_API_HANDLE,
  GSC_THREAD_FAILURE, GSC_ABORTED
}
 

Macro Definition Documentation

◆ GSC_DEFAULT

#define GSC_DEFAULT   0xFFFFFFFEUL

◆ GSC_FIELD_DECODE

#define GSC_FIELD_DECODE (   r,
  b,
 
)    (((r)>>(e)) & (0xFFFFFFFFUL >> (31-((b)-(e)))))

◆ GSC_FIELD_ENCODE

#define GSC_FIELD_ENCODE (   v,
  b,
 
)    (((v) << (e)) & ((~0UL << (e)) & (~0UL >> (31 - (b)))))

◆ GSC_IO_STATUS_ABORTED

#define GSC_IO_STATUS_ABORTED   0x30000000 /* 3 */

◆ GSC_IO_STATUS_ACTIVE

#define GSC_IO_STATUS_ACTIVE   0x10000000 /* 1 */

◆ GSC_IO_STATUS_COUNT_MASK

#define GSC_IO_STATUS_COUNT_MASK   0x0FFFFFFF /* 256MB */

◆ GSC_IO_STATUS_ERROR

#define GSC_IO_STATUS_ERROR   0x40000000 /* 4 */

◆ GSC_IO_STATUS_MASK

#define GSC_IO_STATUS_MASK   0x70000000 /* Current status */

◆ GSC_IO_STATUS_SUCCESS

#define GSC_IO_STATUS_SUCCESS   0x00000000 /* 0 */

◆ GSC_IO_STATUS_TIMEOUT

#define GSC_IO_STATUS_TIMEOUT   0x20000000 /* 2 */

◆ GSC_IO_STATUS_TX

#define GSC_IO_STATUS_TX   0x80000000

◆ GSC_NO_CHANGE

#define GSC_NO_CHANGE   0xFFFFFFFFUL

◆ GSC_PROCESS_OPEN_MAX

#define GSC_PROCESS_OPEN_MAX   8

◆ GSC_REG_ENCODE

#define GSC_REG_ENCODE (   t,
  s,
 
)
Value:
(((t) & 0xC000) | \
GSC_FIELD_ENCODE((s) - 1,13,12) | \
GSC_FIELD_ENCODE((o),11,0))
t
Definition: hs01.m:4
popt Meyer s(reformulated) problem p0

◆ GSC_REG_GSC

#define GSC_REG_GSC   0x0000

◆ GSC_REG_OFFSET

#define GSC_REG_OFFSET (   r)    GSC_FIELD_DECODE((r),11,0)

◆ GSC_REG_PCI

#define GSC_REG_PCI   0x8000

◆ GSC_REG_PLDA

#define GSC_REG_PLDA   0x4000

◆ GSC_REG_PLX

#define GSC_REG_PLX   0x4000

◆ GSC_REG_SIZE

#define GSC_REG_SIZE (   r)    (GSC_FIELD_DECODE((r),13,12) + 1)

◆ GSC_REG_TYPE

#define GSC_REG_TYPE (   r)    ((r) & 0xC000)

◆ GSC_VERSION_DRIVER

#define GSC_VERSION_DRIVER   1 /* Device Driver Version */

◆ GSC_VERSION_LIBRARY

#define GSC_VERSION_LIBRARY   0 /* API Library Version */

Enumeration Type Documentation

◆ gsc_status_t

Enumerator
GSC_SUCCESS 
GSC_FAILED 
GSC_ACCESS_DENIED 
GSC_DMA_CHANNEL_UNAVAILABLE 
GSC_DMA_CHANNEL_INVALID 
GSC_DMA_CHANNEL_TYPE_ERROR 
GSC_DMA_IN_PROGRESS 
GSC_DMA_DONE 
GSC_DMA_PAUSED 
GSC_DMA_NOT_PAUSED 
GSC_DMA_CHANNEL_COMMAND_INVALID 
GSC_DMA_MAN_READY 
GSC_DMA_MAN_NOT_READY 
GSC_DMA_INVALID_CHANNEL_PRIORITY 
GSC_DMA_MAN_CORRUPTED 
GSC_DMA_INVALID_ELEMENT_INDEX 
GSC_DMA_NO_MORE_ELEMENTS 
GSC_DMA_SGL_INVALID 
GSC_DMA_SGL_QUEUE_FULL 
GSC_NULL_PARAM 
GSC_INVALID_BUS_INDEX 
GSC_UNSUPPORTED_FUNCTION 
GSC_INVALID_PCI_SPACE 
GSC_INVALID_IOP_SPACE 
GSC_INVALID_SIZE 
GSC_INVALID_ADDRESS 
GSC_INVALID_ADDRESS_TYPE 
GSC_INVALID_INDEX 
GSC_MU_NOT_READY 
GSC_MU_FIFO_EMPTY 
GSC_MU_FIFO_FULL 
GSC_INVALID_REGISTER 
GSC_DOORBELL_CLEAR_FAILED 
GSC_INVALID_USER_PIN 
GSC_INVALID_USER_STATE 
GSC_EEPROM_NOT_PRESENT 
GSC_EEPROMP_TYPE_NOT_SUPPORTED 
GSC_EEPROM_BLANK 
GSC_CONFIG_ACCESS_FAILED 
GSC_INVALID_DEVICE_INFO 
GSC_NO_ACTIVE_DRIVER 
GSC_INSUFFICIENT_RESOURCES 
GSC_OBJECT_ALREADY_ALLOCATED 
GSC_ALREADY_INITIALIZED 
GSC_NOT_INITIALIZED 
GSC_BAD_CONFIG_REG_ENDIAN_MODE 
GSC_INVALID_POWER_STATE 
GSC_POWER_DOWN 
GSC_FLYBY_NOT_SUPPORTED 
GSC_CHANNEL_NOT_SUPPORTED 
GSC_NO_ACTION 
GSC_HS_NOT_SUPPORTED 
GSC_VP_NOT_SUPPORTED 
GSC_VPD_NOT_ENABLED 
GSC_NO_MORE_CAP 
GSC_INVALID_OFFSET 
GSC_BAD_PIN_DIRECTION 
GSC_PCI_TIMEOUT 
GSC_DMA_CHANNEL_CLOSED 
GSC_DMA_CHANNEL_ERROR 
GSC_INVALID_HANDLE 
GSC_BUFFER_NOT_READY 
GSC_INVALID_DATA 
GSC_DO_NOTHING 
GSC_DMA_SGL_BUILD_FAILED 
GSC_PM_NOT_SUPPORTED 
GSC_INVALID_VERSION_DRIVER 
GSC_WAIT_TIMEOUT 
GSC_WAIT_CANCELED 
GSC_LIB_LOAD_FAILURE 
GSC_RESERVED2 
GSC_INIT_FAILURE 
GSC_INVALID_VERSION_API 
GSC_RESERVED 
GSC_INTERNAL_ERROR 
GSC_TOO_MANY_OPEN_HANDLES 
GSC_INVALID_API_HANDLE 
GSC_THREAD_FAILURE 
GSC_ABORTED 
GSC_SUCCESS 
GSC_FAILED 
GSC_ACCESS_DENIED 
GSC_DMA_CHANNEL_UNAVAILABLE 
GSC_DMA_CHANNEL_INVALID 
GSC_DMA_CHANNEL_TYPE_ERROR 
GSC_DMA_IN_PROGRESS 
GSC_DMA_DONE 
GSC_DMA_PAUSED 
GSC_DMA_NOT_PAUSED 
GSC_DMA_CHANNEL_COMMAND_INVALID 
GSC_DMA_MAN_READY 
GSC_DMA_MAN_NOT_READY 
GSC_DMA_INVALID_CHANNEL_PRIORITY 
GSC_DMA_MAN_CORRUPTED 
GSC_DMA_INVALID_ELEMENT_INDEX 
GSC_DMA_NO_MORE_ELEMENTS 
GSC_DMA_SGL_INVALID 
GSC_DMA_SGL_QUEUE_FULL 
GSC_NULL_PARAM 
GSC_INVALID_BUS_INDEX 
GSC_UNSUPPORTED_FUNCTION 
GSC_INVALID_PCI_SPACE 
GSC_INVALID_IOP_SPACE 
GSC_INVALID_SIZE 
GSC_INVALID_ADDRESS 
GSC_INVALID_ADDRESS_TYPE 
GSC_INVALID_INDEX 
GSC_MU_NOT_READY 
GSC_MU_FIFO_EMPTY 
GSC_MU_FIFO_FULL 
GSC_INVALID_REGISTER 
GSC_DOORBELL_CLEAR_FAILED 
GSC_INVALID_USER_PIN 
GSC_INVALID_USER_STATE 
GSC_EEPROM_NOT_PRESENT 
GSC_EEPROMP_TYPE_NOT_SUPPORTED 
GSC_EEPROM_BLANK 
GSC_CONFIG_ACCESS_FAILED 
GSC_INVALID_DEVICE_INFO 
GSC_NO_ACTIVE_DRIVER 
GSC_INSUFFICIENT_RESOURCES 
GSC_OBJECT_ALREADY_ALLOCATED 
GSC_ALREADY_INITIALIZED 
GSC_NOT_INITIALIZED 
GSC_BAD_CONFIG_REG_ENDIAN_MODE 
GSC_INVALID_POWER_STATE 
GSC_POWER_DOWN 
GSC_FLYBY_NOT_SUPPORTED 
GSC_CHANNEL_NOT_SUPPORTED 
GSC_NO_ACTION 
GSC_HS_NOT_SUPPORTED 
GSC_VP_NOT_SUPPORTED 
GSC_VPD_NOT_ENABLED 
GSC_NO_MORE_CAP 
GSC_INVALID_OFFSET 
GSC_BAD_PIN_DIRECTION 
GSC_PCI_TIMEOUT 
GSC_DMA_CHANNEL_CLOSED 
GSC_DMA_CHANNEL_ERROR 
GSC_INVALID_HANDLE 
GSC_BUFFER_NOT_READY 
GSC_INVALID_DATA 
GSC_DO_NOTHING 
GSC_DMA_SGL_BUILD_FAILED 
GSC_PM_NOT_SUPPORTED 
GSC_INVALID_VERSION_DRIVER 
GSC_WAIT_TIMEOUT 
GSC_WAIT_CANCELED 
GSC_LIB_LOAD_FAILURE 
GSC_RESERVED2 
GSC_INIT_FAILURE 
GSC_INVALID_VERSION_API 
GSC_RESERVED 
GSC_INTERNAL_ERROR 
GSC_TOO_MANY_OPEN_HANDLES 
GSC_INVALID_API_HANDLE 
GSC_THREAD_FAILURE 
GSC_ABORTED