IGSC_ERRORS - Man Page

Synopsis

Topics

Firmware_status

Data Structures

struct igsc_hw_config
structure to store hw configuration
struct igsc_subsystem_ids
structure to store device subsystem ids
struct igsc_device_handle

Macros

#define IGSC_HW_CONFIG_BLOB_SIZE   48
#define IGSC_MAX_IMAGE_SIZE   (8*1024*1024) /* 8M */
Maximum firmware image size.

Igsc_errors

The Library return codes

#define IGSC_ERROR_BASE   0x0000U
#define IGSC_SUCCESS   (IGSC_ERROR_BASE + 0)
#define IGSC_ERROR_INTERNAL   (IGSC_ERROR_BASE + 1)
#define IGSC_ERROR_NOMEM   (IGSC_ERROR_BASE + 2)
#define IGSC_ERROR_INVALID_PARAMETER   (IGSC_ERROR_BASE + 3)
#define IGSC_ERROR_DEVICE_NOT_FOUND   (IGSC_ERROR_BASE + 4)
#define IGSC_ERROR_BAD_IMAGE   (IGSC_ERROR_BASE + 5)
#define IGSC_ERROR_PROTOCOL   (IGSC_ERROR_BASE + 6)
#define IGSC_ERROR_BUFFER_TOO_SMALL   (IGSC_ERROR_BASE + 7)
#define IGSC_ERROR_INVALID_STATE   (IGSC_ERROR_BASE + 8)
#define IGSC_ERROR_NOT_SUPPORTED   (IGSC_ERROR_BASE + 9)
#define IGSC_ERROR_INCOMPATIBLE   (IGSC_ERROR_BASE + 10)
#define IGSC_ERROR_TIMEOUT   (IGSC_ERROR_BASE + 11)
#define IGSC_ERROR_PERMISSION_DENIED   (IGSC_ERROR_BASE + 12)
#define IGSC_ERROR_BUSY   (IGSC_ERROR_BASE + 13)

Detailed Description

Data Structure Documentation

struct igsc_hw_config

structure to store hw configuration

Parameters

format_version version of the hw config
blob hardware configuration data

Definition at line 334 of file igsc_lib.h.

Data Fields:

uint8_t blob[IGSC_HW_CONFIG_BLOB_SIZE]

uint32_t format_version

struct igsc_subsystem_ids

structure to store device subsystem ids

Parameters

ssvid subsystem vendor id
ssdid subsystem device id

Definition at line 344 of file igsc_lib.h.

Data Fields:

uint16_t ssdid

uint16_t ssvid

struct igsc_device_handle

Structure to store GSC FU device data

Definition at line 360 of file igsc_lib.h.

Data Fields:

struct igsc_lib_ctx * ctx Internal library context

Macro Definition Documentation

#define IGSC_ERROR_BAD_IMAGE   (IGSC_ERROR_BASE + 5)

Provided image has wrong format

Definition at line 311 of file igsc_lib.h.

#define IGSC_ERROR_BASE   0x0000U

Error Base

Definition at line 305 of file igsc_lib.h.

#define IGSC_ERROR_BUFFER_TOO_SMALL   (IGSC_ERROR_BASE + 7)

Provided buffer is too small

Definition at line 313 of file igsc_lib.h.

#define IGSC_ERROR_BUSY   (IGSC_ERROR_BASE + 13)

Device is currently busy, try again later

Definition at line 319 of file igsc_lib.h.

#define IGSC_ERROR_DEVICE_NOT_FOUND   (IGSC_ERROR_BASE + 4)

Requested device was not found

Definition at line 310 of file igsc_lib.h.

#define IGSC_ERROR_INCOMPATIBLE   (IGSC_ERROR_BASE + 10)

Incompatible request

Definition at line 316 of file igsc_lib.h.

#define IGSC_ERROR_INTERNAL   (IGSC_ERROR_BASE + 1)

Internal Error

Definition at line 307 of file igsc_lib.h.

#define IGSC_ERROR_INVALID_PARAMETER   (IGSC_ERROR_BASE + 3)

Invalid parameter was provided

Definition at line 309 of file igsc_lib.h.

#define IGSC_ERROR_INVALID_STATE   (IGSC_ERROR_BASE + 8)

Invalid library internal state

Definition at line 314 of file igsc_lib.h.

#define IGSC_ERROR_NOMEM   (IGSC_ERROR_BASE + 2)

Memory Allocation Failed

Definition at line 308 of file igsc_lib.h.

#define IGSC_ERROR_NOT_SUPPORTED   (IGSC_ERROR_BASE + 9)

Unsupported request

Definition at line 315 of file igsc_lib.h.

#define IGSC_ERROR_PERMISSION_DENIED   (IGSC_ERROR_BASE + 12)

The process doesn't have access rights

Definition at line 318 of file igsc_lib.h.

#define IGSC_ERROR_PROTOCOL   (IGSC_ERROR_BASE + 6)

Error in the update protocol

Definition at line 312 of file igsc_lib.h.

#define IGSC_ERROR_TIMEOUT   (IGSC_ERROR_BASE + 11)

The operation has timed out

Definition at line 317 of file igsc_lib.h.

#define IGSC_HW_CONFIG_BLOB_SIZE   48

Definition at line 327 of file igsc_lib.h.

#define IGSC_MAX_IMAGE_SIZE   (8*1024*1024) /* 8M */

Maximum firmware image size.

Definition at line 353 of file igsc_lib.h.

#define IGSC_SUCCESS   (IGSC_ERROR_BASE + 0)

Success

Definition at line 306 of file igsc_lib.h.

Author

Generated automatically by Doxygen for Intel Graphics System Controller Firmware Update Library from the source code.

Info

Intel Graphics System Controller Firmware Update Library