Document Organization | Intel ZT 4901 manual

Document Organization

Appendix G, “RH Switchover on OS Crash,” describes how the High-Availability Redundant Host architecture enables the system master board to perform a switchover to the backup host in the event of a system crash under the Linux and VxWorks operating systems.

Appendix H, “Data Sheet Reference,” provides links to specifications and user documentation relevant to the High Availability Software Development Kit.

10	Intel® NetStructureTM ZT 4901 High Availability Software Technical Product Specification

Image 10

Intel ZT 4901 manual Document Organization

Contents

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