ImbOpenDriver, ImbCloseDriver, ImbDeviceIoControl | Intel ZT 4901

IPMI API

8

8.1imbOpenDriver

Prototype:

int imbOpenDriver(void)

Parameters:

None

Returns:

Int - 0 for Fail and 1 for Success, sets hDevice

Description:

Establish a link to the IMB driver.

8.2imbCloseDriver

Prototype:

void imbCloseDriver()

Parameters:

None

Returns:

None

Description:

Close a link to the IMB driver.

8.3imbDeviceIoControl

Prototype:

static BOOL imbDeviceIoControl(

HANDLE dummy_hDevice,

DWORD dwIoControlCode,

LPVOID lpvInBuffer,

DWORD cbInBuffer,

High Availability Software for the Intel® NetStructureTM ZT 4901 Technical Product Specification

79

Image 79

Intel ZT 4901 manual ImbOpenDriver, ImbCloseDriver, ImbDeviceIoControl

Contents

Intel NetStructureTM ZT 4901 High Availability Software Technical Product SpecificationPage Contents Hot Swap API Demonstration Utilities Tables Figures Date Revision Description Revision History This page intentionally left blank Document Organization Document Organization Terminology IntroductionFollowing terms are commonly used in this document Introduction Introduction High Availability Hardware Approach PCI Processor BoardsCIC Bridge Mezzanine RSS Processor Board Block Diagram Backplane RSS Host with Bridge Mezzanine Block Diagram Host Application High-Availability Software ApproachHost application System Management Backplane Device Drivers System Management Backplane Device Drivers Portability ServiceabilityHost Application Software Goals of the Host Application Host Application Software Division of Labor Development Issues Hardened Applications Graceful SwitchoverCode Modularity Redundant Host API System ManagementIpmi API Slot Control API Fault ConfigurationBaseboard Management Controller Firmware Enhancements Hot Swap API Channel Definitions for ZT Isolation Strategies RH Channel Enabled Ipmi RH Channel CommandsRH Channel Get RH BMC Address Request Response This page intentionally left blank Device Driver Design High Availability CompactPCI Device Drivers Activation Device Driver StatesInitialization Quiesced Removed Adding High-Availability FunctionalityFind Device Resume Operations Add Device Remove Device Suspend OperationsDriver Synchronization Summary RhSetHostName RhGetHwDestinationHostAndResetRedundant Host API Intel-Specific APIs Hsistatusinvalidparameter Redundant Host PICMG* 2.12 APIsRedundant Host API Hsistatussuccess Following topics specify each of the interface functions Definitions and Types Minoralarm Majoralarm Criticalalarm Rhalarmseverity RESETREQUIRED, Resetnotrequired Unknown Rhslotneedsreset Hsistatusinsufficientbuffer Initialization/TerminationRhEnumerateInstances Hsistatusno Datadetected RhEnumerateInstances RhOpenRhOpen Char *InstanceId Optional OUT Rhhandle *pHandle InstanceId Handle RhCloseRhGetInstanceID RhClose in Rhhandle Handle RhGetDomainCount Rhhandle Handle OUT uint32 *pCount Handle Handle of the current session PInstanceIDDomain and Host Information API RhGetDomainCount Handle Handle of the current session PCount RhGetDomainNumbersSystem RhGetDomainSlotPath RhGetDomainOwnership HSISTATUSINSUFFICIENTBUFFER, this is the minimum Domain is written as a null-terminated stringSlotPathLength Character RhGetDomainSlots RhGetDomainSlotCountIs placed RhGetSlotDomain RhGetHostCount RhGetCurrentHostNumberRhGetCurrentHostNumber Rhhandle Handle OUT uint32 *pHost RhGetHostCount Rhhandle Handle OUT uint32 *pHostCount RhGetHostNumbersHandle Handle of the current session PHostCount RhGetHostName False RhSetHostAvailability RhGetHostAvailability RhGetDomainAvailabilityToHost Slot Information APIRhGetPhysicalSlotInformation Devices directly placed in the physical slots HsinosuchdeviceIf the specified slot is empty Rhslotdescriptor By two characters from the set ‘0’..’9’, ‘A’..’F’ RhGetSlotChildInformationSlotPath + FunctionNumber for the corresponding PCI-PCI bridge If there are no child devices below the specified bridge Handle Handle of the current session PhysSlot PCI buses in the system Switchover Scenarios and Theory of Operation Switchover API Partially Cooperative Switchover Hostile Switchover RhPrepareForSwitchover Hsistatusrequestdenied Hsistatussuccess returned in the case of success RhCancelPrepareForSwitchover RhGetDomainSwConnectionStatus RhGetSlotSwConnectionStatus RhPerformSwitchoverInvalid session handle or the specified slot does not exist Specified domains RhSetHwDestinationHostHandle Handle of the current session DestinationHost Value Rhnodestinationhost means no host should own Rhnodestinationhost means no host owns the domains RhEnableDomainStateNotification Notification, Reporting and AlarmsRhGetHwDestinationHost Disconnecting RhEnableSwitchoverNotificationDuring software connection and disconnection Switchovers in which it participates RhEnableSwitchoverRequestNotification RhEnableUnsafeSwitchoverNotification Indicates is the depth of the device below the physical slot Device in unsafe state RhDisableNotification Handle Handle of the current session NotificationType Hot Swap API Hot Swap API ImbCloseDriver ImbOpenDriverImbDeviceIoControl Lpdword ImbSendTimedI2cRequestLpvoid Dword ImbGetAsyncMessage ImbSendIpmiRequestAccesnstatus EventId EventID handle returned once registered ImbIsAsyncMessageAvailableImbRegisterForAsyncMsgNotification ImbUnregisterForAsyncMsgNotification ImbSetLocalBmcAddr ImbGetLocalBmcAddr Current determined Ipmi version ImbGetIpmiVersionByte imbGetIpmiVersion Byte Hsistatusnomemory Slot Control APIHsiOpenSlotControl HsiCloseSlotControl HsiGetBoardPresent HsiGetSlotCountSlot Control API Hsistatusnodatadetected HsiGetBoardHealthy Healthy HsiGetSlotPower HsiGetSlotReset HsiSetSlotPower Hsistatusnotimplemented HsiSetSlotResetSlot Physical slot number False 66 MHz operation is not enabled for the slot HsiGetSlotM66EnableHsiapidef Hsistatus HsiSetSlotM66Enable Returned if the arguments or handle is invalid HsiSetSlotEventCallbackHandle Handle of the current session Callback Function Hsisloteventinfostruct Void *HSISLOTEVENTCALLBACKHsisloteventinfo RH Interface Demonstration UtilitiesFunctional Description User Interface Demonstration Utilities Multiple Mode CapabilitiesSoftware Initiated Handovers Hardware Initiated Failovers Slot Information Switchover FunctionsNotification, Reporting and Alarms Host Domain Enumeration and Association Ipmi Interface Fault ConfigurationIsolation Strategy HS Functional Description Hot Swap Interface PCI Tree Information Retrieval Flags Slot Information Structure Slot State Slot Control Interface Demonstration Utilities Installing the Redundant Host Software Kit Software InstallationLinux Software Installation Installing RH Source RPMSource Installation Patching and Rebuilding an RH-Enabled Kernel 2 /lib/modules/slotcntrl.o Configuring the Redundant Host InfrastructureMaking RH Configuration Changes 1 /lib/modules/priBptd.o 3 /CompactPCI-RH-1.0/app/lib VxWorks Tornado II Setup4 /CompactPCI-RH-1.0/app/bin RedundantHostFunctionReturnValuesB Redundant Host Function Return Values Hsistatusnosysrhtablefound Hsistatusnosuchbridge Hsistatusoperationaborted HsistatusnotavailibleHsistatusnotready Hsistatusobjectdoesnotexist Hsistatusuptinsertionfailed HsistatusunabletosendpacketHsistatusunsuccessfultranslation Hsistatusunsupportedplatform This page intentionally left blank HSK Driver Object Declaration HSK Device Driver Interface for VxWorks HSK Device Driver Interface for VxWorks HSK Device Information Structure Compatlistcheckdevice HSK Driver Instantiation Code Segment Prhdeviceobj AddDevice Redundant Host-Aware Callback Definitions Hsistatussuccess if successful otherwise Hsistatusfailure Hsistatus StartDeviceHsistatus StopDevice Prhdeviceobj deviceobject Hsistatus SurpriseRemoval Hsistatus RemoveDevice Hsistatus rhHskRegisterMsgCallback RH-Aware Message Registration Definitions Int rhHskUnregisterMsgCallback Process Packet Callback DefinitionPcilocation pci Length in bytes of the data packet being sent RH-Aware Send Message DefinitionHsistatus rhHskSendMessage UINT8* pBuf, int iLen, Pvoid pContext PPackett Alternate Hscsr Interfaces RH Device Driver Interface for Linux RH Device Driver Interface for Linux Support for Unmodified Standard Drivers Design Guideline for Peripheral VendorsENon Bus Mastering Peripheral Bus Mastering DMA Capable Peripheral Design Guideline for Peripheral Vendors Category ZT 5550 Functions Redundant Host Functions Porting ZT 5550 HA Applications to Picmg HASetEthernetRou Porting ZT 5550 HA Applications to PicmgHAGetEthernetRo Uting RH Switchover on OS Crash RH Switchover on OS Crash Wind River* VxWorks Programmer’s Guide is available at Data Sheet ReferenceCompactPCI User Documentation VxWorks Data Sheet Reference Impi Index Ipmi API Page This page intentionally left blank