IpmiNetFnStorage.h File Reference

Data Structures
struct	IPMI_GET_FRU_INVENTORY_AREA_INFO_REQUEST
struct	IPMI_GET_FRU_INVENTORY_AREA_INFO_RESPONSE
struct	IPMI_FRU_COMMON_DATA
struct	IPMI_FRU_READ_COMMAND
struct	IPMI_READ_FRU_DATA_REQUEST
struct	IPMI_READ_FRU_DATA_RESPONSE
struct	IPMI_FRU_WRITE_COMMAND
struct	IPMI_WRITE_FRU_DATA_REQUEST
struct	IPMI_WRITE_FRU_DATA_RESPONSE
union	IPMI_SDR_OPERATION_SUPPORT
struct	IPMI_GET_SDR_REPOSITORY_INFO_RESPONSE
struct	IPMI_RESERVE_SDR_REPOSITORY_RESPONSE
union	IPMI_SDR_RECORD_SENSOR_INIT
union	IPMI_SDR_RECORD_SENSOR_CAP
union	IPMI_SDR_RECORD_LINEARIZATION
union	IPMI_SDR_RECORD_M_TOLERANCE
union	IPMI_SDR_RECORD_B_ACCURACY
union	IPMI_SDR_RECORD_ACCURACY_SENSOR_DIR
union	IPMI_SDR_RECORD_R_EXP_B_EXP
union	IPMI_SDR_RECORD_ANALOG_FLAGS
struct	IPMI_SDR_RECORD_STRUCT_1
struct	IPMI_SDR_RECORD_STRUCT_2
union	IPMI_FRU_DATA_INFO
union	IPMI_SDR_RECORD_DEV_ID_STR_TYPE_LENGTH
struct	IPMI_SDR_RECORD_STRUCT_11
struct	IPMI_SDR_RECORD_STRUCT_C0
struct	IPMI_SDR_RECORD_STRUCT_HEADER
union	IPMI_SENSOR_RECORD_STRUCT
struct	IPMI_GET_SDR_REQUEST
struct	IPMI_GET_SDR_RESPONSE
struct	IPMI_GET_SEL_INFO_RESPONSE
struct	IPMI_RESERVE_SEL_RESPONSE
struct	IPMI_SEL_EVENT_RECORD_DATA
struct	IPMI_TIMESTAMPED_OEM_SEL_RECORD_DATA
struct	IPMI_NON_TIMESTAMPED_OEM_SEL_RECORD_DATA
struct	IPMI_GET_SEL_ENTRY_REQUEST
struct	IPMI_GET_SEL_ENTRY_RESPONSE
struct	IPMI_ADD_SEL_ENTRY_REQUEST
struct	IPMI_ADD_SEL_ENTRY_RESPONSE
struct	IPMI_PARTIAL_ADD_SEL_ENTRY_REQUEST
struct	IPMI_PARTIAL_ADD_SEL_ENTRY_RESPONSE
struct	IPMI_DELETE_SEL_ENTRY_REQUEST
struct	IPMI_DELETE_SEL_ENTRY_RESPONSE
struct	IPMI_CLEAR_SEL_REQUEST
struct	IPMI_CLEAR_SEL_RESPONSE
struct	IPMI_GET_SEL_TIME_RESPONSE
struct	IPMI_SET_SEL_TIME_REQUEST
struct	IPMI_GET_SEL_TIME_UTC_OFFSET_RESPONSE

Macros
#define	IPMI_NETFN_STORAGE   0x0A
#define	IPMI_STORAGE_GET_FRU_INVENTORY_AREAINFO   0x10
#define	IPMI_STORAGE_READ_FRU_DATA   0x11
#define	IPMI_STORAGE_WRITE_FRU_DATA   0x12
#define	IPMI_STORAGE_GET_SDR_REPOSITORY_INFO   0x20
#define	IPMI_STORAGE_GET_SDR_REPOSITORY_ALLOCATION_INFO   0x21
#define	IPMI_STORAGE_RESERVE_SDR_REPOSITORY   0x22
#define	IPMI_STORAGE_GET_SDR   0x23
#define	IPMI_STORAGE_ADD_SDR   0x24
#define	IPMI_STORAGE_PARTIAL_ADD_SDR   0x25
#define	IPMI_STORAGE_DELETE_SDR   0x26
#define	IPMI_STORAGE_CLEAR_SDR   0x27
#define	IPMI_STORAGE_GET_SDR_REPOSITORY_TIME   0x28
#define	IPMI_STORAGE_SET_SDR_REPOSITORY_TIME   0x29
#define	IPMI_STORAGE_ENTER_SDR_UPDATE_MODE   0x2A
#define	IPMI_STORAGE_EXIT_SDR_UPDATE_MODE   0x2B
#define	IPMI_STORAGE_RUN_INIT_AGENT   0x2C
#define	IPMI_STORAGE_GET_SEL_INFO   0x40
#define	IPMI_GET_SEL_INFO_OPERATION_SUPPORT_GET_SEL_ALLOCATION_INFO_CMD   BIT0
#define	IPMI_GET_SEL_INFO_OPERATION_SUPPORT_RESERVE_SEL_CMD   BIT1
#define	IPMI_GET_SEL_INFO_OPERATION_SUPPORT_PARTIAL_ADD_SEL_ENTRY_CMD   BIT2
#define	IPMI_GET_SEL_INFO_OPERATION_SUPPORT_DELETE_SEL_CMD   BIT3
#define	IPMI_GET_SEL_INFO_OPERATION_SUPPORT_OVERFLOW_FLAG   BIT7
#define	IPMI_STORAGE_GET_SEL_ALLOCATION_INFO   0x41
#define	IPMI_STORAGE_RESERVE_SEL   0x42
#define	IPMI_STORAGE_GET_SEL_ENTRY   0x43
#define	IPMI_STORAGE_ADD_SEL_ENTRY   0x44
#define	IPMI_STORAGE_PARTIAL_ADD_SEL_ENTRY   0x45
#define	IPMI_STORAGE_DELETE_SEL_ENTRY   0x46
#define	IPMI_DELETE_SEL_ENTRY_RESPONSE_TYPE_UNSUPPORTED   0x80
#define	IPMI_DELETE_SEL_ENTRY_RESPONSE_ERASE_IN_PROGRESS   0x81
#define	IPMI_STORAGE_CLEAR_SEL   0x47
#define	IPMI_CLEAR_SEL_REQUEST_C_CHAR_ASCII   0x43
#define	IPMI_CLEAR_SEL_REQUEST_L_CHAR_ASCII   0x4C
#define	IPMI_CLEAR_SEL_REQUEST_R_CHAR_ASCII   0x52
#define	IPMI_CLEAR_SEL_REQUEST_INITIALIZE_ERASE   0xAA
#define	IPMI_CLEAR_SEL_REQUEST_GET_ERASE_STATUS   0x00
#define	IPMI_CLEAR_SEL_RESPONSE_ERASURE_IN_PROGRESS   0x00
#define	IPMI_CLEAR_SEL_RESPONSE_ERASURE_COMPLETED   0x01
#define	IPMI_STORAGE_GET_SEL_TIME   0x48
#define	IPMI_STORAGE_SET_SEL_TIME   0x49
#define	IPMI_STORAGE_GET_AUXILLARY_LOG_STATUS   0x5A
#define	IPMI_STORAGE_SET_AUXILLARY_LOG_STATUS   0x5B
#define	IPMI_STORAGE_GET_SEL_TIME_UTC_OFFSET   0x5C
#define	IPMI_STORAGE_SET_SEL_TIME_UTC_OFFSET   0x5D
#define	IPMI_COMPLETE_SEL_RECORD   0xFF
#define	IPMI_SEL_SYSTEM_RECORD   0x02
#define	IPMI_SEL_OEM_TIME_STAMP_RECORD_START   0xC0
#define	IPMI_SEL_OEM_TIME_STAMP_RECORD_END   0xDF
#define	IPMI_SEL_OEM_NO_TIME_STAMP_RECORD_START   0xE0
#define	IPMI_SEL_OEM_NO_TIME_STAMP_RECORD_END   0xFF
#define	IPMI_SEL_EVENT_DIR(EventDirType)   (EventDirType >> 7)
#define	IPMI_SEL_EVENT_DIR_ASSERTION_EVENT   0x00
#define	IPMI_SEL_EVENT_DIR_DEASSERTION_EVENT   0x01
#define	IPMI_SEL_EVENT_TYPE(EventDirType)   (EventDirType & 0x7F)
#define	IPMI_SEL_EVENT_TYPE_UNSPECIFIED   0x00
#define	IPMI_SEL_EVENT_TYPE_THRESHOLD   0x01
#define	IPMI_SEL_EVENT_TYPE_GENERIC_START   0x02
#define	IPMI_SEL_EVENT_TYPE_GENERIC_END   0x0C
#define	IPMI_SEL_EVENT_TYPE_SENSOR_SPECIFIC   0x6F
#define	IPMI_SEL_EVENT_TYPE_OEM_START   0x70
#define	IPMI_SEL_EVENT_TYPE_OEM_END   0x7F
#define	SOFTWARE_ID_FROM_GENERATOR_ID(GeneratorId)   ((GeneratorId & 0xFF) >> 1)
#define	IPMI_SWID_BIOS_RANGE_START   0x00
#define	IPMI_SWID_BIOS_RANGE_END   0x0F
#define	IPMI_SWID_SMI_HANDLER_RANGE_START   0x10
#define	IPMI_SWID_SMI_HANDLER_RANGE_END   0x1F
#define	IPMI_SWID_SMS_RANGE_START   0x20
#define	IPMI_SWID_SMS_RANGE_END   0x2F
#define	IPMI_SWID_OEM_RANGE_START   0x30
#define	IPMI_SWID_OEM_RANGE_END   0x3F
#define	IPMI_SWID_REMOTE_CONSOLE_RANGE_START   0x40
#define	IPMI_SWID_REMOTE_CONSOLE_RANGE_END   0x46
#define	IPMI_SWID_TERMINAL_REMOTE_CONSOLE_ID   0x47
#define	SLAVE_ADDRESS_FROM_GENERATOR_ID(GeneratorId)   ((GeneratorId & 0xFF) >> 1)
#define	LUN_FROM_GENERATOR_ID(GeneratorId)   ((GeneratorId >> 8) & 0x03)
#define	CHANNEL_NUMBER_FROM_GENERATOR_ID(GeneratorId)   ((GeneratorId >> 12) & 0x0F)
#define	IPMI_EVM_REVISION   0x04
#define	IPMI_BIOS_ID   0x18
#define	IPMI_FORMAT_REV   0x00
#define	IPMI_FORMAT_REV1   0x01
#define	IPMI_SOFTWARE_ID   0x01
#define	IPMI_PLATFORM_VAL_ID   0x01
#define	IPMI_GENERATOR_ID(i, f)   ((i << 1) | (f << 1) | IPMI_SOFTWARE_ID)
#define	IPMI_SENSOR_TYPE_EVENT_CODE_DISCRETE   0x6F
#define	IPMI_OEM_SPECIFIC_DATA   0x02
#define	IPMI_SENSOR_SPECIFIC_DATA   0x03

Detailed Description

IPMI 2.0 definitions from the IPMI Specification Version 2.0, Revision 1.1.

This file contains all NetFn Storage commands, including: FRU Inventory Commands (Chapter 34) SDR Repository (Chapter 33) System Event Log(SEL) Commands (Chapter 31) SEL Record Formats (Chapter 32)

See IPMI specification, Appendix G, Command Assignments and Appendix H, Sub-function Assignments.

Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define CHANNEL_NUMBER_FROM_GENERATOR_ID

(

GeneratorId

)

((GeneratorId >> 12) & 0x0F)

#define IPMI_BIOS_ID   0x18

#define IPMI_CLEAR_SEL_REQUEST_C_CHAR_ASCII   0x43

#define IPMI_CLEAR_SEL_REQUEST_GET_ERASE_STATUS   0x00

#define IPMI_CLEAR_SEL_REQUEST_INITIALIZE_ERASE   0xAA

#define IPMI_CLEAR_SEL_REQUEST_L_CHAR_ASCII   0x4C

#define IPMI_CLEAR_SEL_REQUEST_R_CHAR_ASCII   0x52

#define IPMI_CLEAR_SEL_RESPONSE_ERASURE_COMPLETED   0x01

#define IPMI_CLEAR_SEL_RESPONSE_ERASURE_IN_PROGRESS   0x00

#define IPMI_COMPLETE_SEL_RECORD   0xFF

#define IPMI_DELETE_SEL_ENTRY_RESPONSE_ERASE_IN_PROGRESS   0x81

#define IPMI_DELETE_SEL_ENTRY_RESPONSE_TYPE_UNSUPPORTED   0x80

#define IPMI_EVM_REVISION   0x04

#define IPMI_FORMAT_REV   0x00

#define IPMI_FORMAT_REV1   0x01

#define IPMI_GENERATOR_ID	(		i,
			f
	)		((i << 1) | (f << 1) | IPMI_SOFTWARE_ID)

#define IPMI_GET_SEL_INFO_OPERATION_SUPPORT_DELETE_SEL_CMD   BIT3

#define IPMI_GET_SEL_INFO_OPERATION_SUPPORT_GET_SEL_ALLOCATION_INFO_CMD   BIT0

#define IPMI_GET_SEL_INFO_OPERATION_SUPPORT_OVERFLOW_FLAG   BIT7

#define IPMI_GET_SEL_INFO_OPERATION_SUPPORT_PARTIAL_ADD_SEL_ENTRY_CMD   BIT2

#define IPMI_GET_SEL_INFO_OPERATION_SUPPORT_RESERVE_SEL_CMD   BIT1

#define IPMI_NETFN_STORAGE   0x0A

#define IPMI_OEM_SPECIFIC_DATA   0x02

#define IPMI_PLATFORM_VAL_ID   0x01

#define IPMI_SEL_EVENT_DIR

(

EventDirType

)

(EventDirType >> 7)

#define IPMI_SEL_EVENT_DIR_ASSERTION_EVENT   0x00

#define IPMI_SEL_EVENT_DIR_DEASSERTION_EVENT   0x01

#define IPMI_SEL_EVENT_TYPE

(

EventDirType

)

(EventDirType & 0x7F)

#define IPMI_SEL_EVENT_TYPE_GENERIC_END   0x0C

#define IPMI_SEL_EVENT_TYPE_GENERIC_START   0x02

#define IPMI_SEL_EVENT_TYPE_OEM_END   0x7F

#define IPMI_SEL_EVENT_TYPE_OEM_START   0x70

#define IPMI_SEL_EVENT_TYPE_SENSOR_SPECIFIC   0x6F

#define IPMI_SEL_EVENT_TYPE_THRESHOLD   0x01

#define IPMI_SEL_EVENT_TYPE_UNSPECIFIED   0x00

#define IPMI_SEL_OEM_NO_TIME_STAMP_RECORD_END   0xFF

#define IPMI_SEL_OEM_NO_TIME_STAMP_RECORD_START   0xE0

#define IPMI_SEL_OEM_TIME_STAMP_RECORD_END   0xDF

#define IPMI_SEL_OEM_TIME_STAMP_RECORD_START   0xC0

#define IPMI_SEL_SYSTEM_RECORD   0x02

#define IPMI_SENSOR_SPECIFIC_DATA   0x03

#define IPMI_SENSOR_TYPE_EVENT_CODE_DISCRETE   0x6F

#define IPMI_SOFTWARE_ID   0x01

#define IPMI_STORAGE_ADD_SDR   0x24

#define IPMI_STORAGE_ADD_SEL_ENTRY   0x44

#define IPMI_STORAGE_CLEAR_SDR   0x27

#define IPMI_STORAGE_CLEAR_SEL   0x47

#define IPMI_STORAGE_DELETE_SDR   0x26

#define IPMI_STORAGE_DELETE_SEL_ENTRY   0x46

#define IPMI_STORAGE_ENTER_SDR_UPDATE_MODE   0x2A

#define IPMI_STORAGE_EXIT_SDR_UPDATE_MODE   0x2B

#define IPMI_STORAGE_GET_AUXILLARY_LOG_STATUS   0x5A

#define IPMI_STORAGE_GET_FRU_INVENTORY_AREAINFO   0x10

#define IPMI_STORAGE_GET_SDR   0x23

#define IPMI_STORAGE_GET_SDR_REPOSITORY_ALLOCATION_INFO   0x21

#define IPMI_STORAGE_GET_SDR_REPOSITORY_INFO   0x20

#define IPMI_STORAGE_GET_SDR_REPOSITORY_TIME   0x28

#define IPMI_STORAGE_GET_SEL_ALLOCATION_INFO   0x41

#define IPMI_STORAGE_GET_SEL_ENTRY   0x43

#define IPMI_STORAGE_GET_SEL_INFO   0x40

#define IPMI_STORAGE_GET_SEL_TIME   0x48

#define IPMI_STORAGE_GET_SEL_TIME_UTC_OFFSET   0x5C

#define IPMI_STORAGE_PARTIAL_ADD_SDR   0x25

#define IPMI_STORAGE_PARTIAL_ADD_SEL_ENTRY   0x45

#define IPMI_STORAGE_READ_FRU_DATA   0x11

#define IPMI_STORAGE_RESERVE_SDR_REPOSITORY   0x22

#define IPMI_STORAGE_RESERVE_SEL   0x42

#define IPMI_STORAGE_RUN_INIT_AGENT   0x2C

#define IPMI_STORAGE_SET_AUXILLARY_LOG_STATUS   0x5B

#define IPMI_STORAGE_SET_SDR_REPOSITORY_TIME   0x29

#define IPMI_STORAGE_SET_SEL_TIME   0x49

#define IPMI_STORAGE_SET_SEL_TIME_UTC_OFFSET   0x5D

#define IPMI_STORAGE_WRITE_FRU_DATA   0x12

#define IPMI_SWID_BIOS_RANGE_END   0x0F

#define IPMI_SWID_BIOS_RANGE_START   0x00

#define IPMI_SWID_OEM_RANGE_END   0x3F

#define IPMI_SWID_OEM_RANGE_START   0x30

#define IPMI_SWID_REMOTE_CONSOLE_RANGE_END   0x46

#define IPMI_SWID_REMOTE_CONSOLE_RANGE_START   0x40

#define IPMI_SWID_SMI_HANDLER_RANGE_END   0x1F

#define IPMI_SWID_SMI_HANDLER_RANGE_START   0x10

#define IPMI_SWID_SMS_RANGE_END   0x2F

#define IPMI_SWID_SMS_RANGE_START   0x20

#define IPMI_SWID_TERMINAL_REMOTE_CONSOLE_ID   0x47

#define LUN_FROM_GENERATOR_ID

(

GeneratorId

)

((GeneratorId >> 8) & 0x03)

#define SLAVE_ADDRESS_FROM_GENERATOR_ID

(

GeneratorId

)

((GeneratorId & 0xFF) >> 1)

#define SOFTWARE_ID_FROM_GENERATOR_ID

(

GeneratorId

)

((GeneratorId & 0xFF) >> 1)