Technical Product Specification | Intel ZT 4901 instruction

Intel® NetStructureTM ZT 4901 High Availability Software

Technical Product Specification

April 2003

Order Number: 273856-002

Image 1

Intel manual Intel NetStructureTM ZT 4901 High Availability Software, Technical Product Specification

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 Host Application Software ServiceabilityGoals of the Host Application Portability Host Application Software Division of Labor Development Issues Hardened Applications Graceful SwitchoverCode Modularity Redundant Host API System ManagementIpmi API Baseboard Management Controller Firmware Enhancements Fault ConfigurationHot Swap API Slot Control 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 Initialization Device Driver StatesQuiesced Activation Find Adding High-Availability FunctionalityDevice Removed Resume Operations Add Device Remove Device Suspend OperationsDriver Synchronization Summary Redundant Host API RhGetHwDestinationHostAndResetIntel-Specific APIs RhSetHostName Redundant Host API Redundant Host PICMG* 2.12 APIsHsistatussuccess Hsistatusinvalidparameter Following topics specify each of the interface functions Definitions and Types Minoralarm Majoralarm Criticalalarm Rhalarmseverity RESETREQUIRED, Resetnotrequired Unknown Rhslotneedsreset RhEnumerateInstances Initialization/TerminationHsistatusno Datadetected Hsistatusinsufficientbuffer RhOpen Char *InstanceId Optional OUT Rhhandle *pHandle RhOpenInstanceId RhEnumerateInstances RhGetInstanceID RhCloseRhClose in Rhhandle Handle Handle Domain and Host Information API Handle Handle of the current session PInstanceIDRhGetDomainCount RhGetDomainCount Rhhandle Handle OUT uint32 *pCount Handle Handle of the current session PCount RhGetDomainNumbersSystem RhGetDomainSlotPath RhGetDomainOwnership SlotPathLength Domain is written as a null-terminated stringCharacter 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 False RhSetHostAvailability RhGetHostAvailability RhGetDomainAvailabilityToHost Slot Information APIRhGetPhysicalSlotInformation If the specified slot is empty HsinosuchdeviceRhslotdescriptor Devices directly placed in the physical slots SlotPath RhGetSlotChildInformation+ FunctionNumber for the corresponding PCI-PCI bridge By two characters from the set ‘0’..’9’, ‘A’..’F’ 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 Handle Handle of the current session DestinationHost RhSetHwDestinationHostValue Rhnodestinationhost means no host should own Specified domains 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 Lpvoid ImbSendTimedI2cRequestDword Lpdword ImbGetAsyncMessage ImbSendIpmiRequestAccesnstatus ImbRegisterForAsyncMsgNotification ImbIsAsyncMessageAvailableImbUnregisterForAsyncMsgNotification EventId EventID handle returned once registered ImbSetLocalBmcAddr ImbGetLocalBmcAddr Byte imbGetIpmiVersion ImbGetIpmiVersionByte Current determined Ipmi version HsiOpenSlotControl Slot Control APIHsiCloseSlotControl Hsistatusnomemory 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 Handle Handle of the current session Callback HsiSetSlotEventCallbackFunction Returned if the arguments or handle is invalid Hsisloteventinfostruct Void *HSISLOTEVENTCALLBACKHsisloteventinfo Functional Description Demonstration UtilitiesUser Interface RH Interface Software Initiated Handovers Multiple Mode CapabilitiesHardware Initiated Failovers Demonstration Utilities Notification, Reporting and Alarms Switchover FunctionsHost Domain Enumeration and Association Slot Information 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 Source Installation Installing RH Source RPMPatching and Rebuilding an RH-Enabled Kernel Software Installation Making RH Configuration Changes Configuring the Redundant Host Infrastructure1 /lib/modules/priBptd.o 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 Hsistatusnosysrhtablefound Hsistatusnosuchbridge Hsistatusnotready HsistatusnotavailibleHsistatusobjectdoesnotexist Hsistatusoperationaborted Hsistatusunsuccessfultranslation HsistatusunabletosendpacketHsistatusunsupportedplatform Hsistatusuptinsertionfailed 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 Hsistatus StopDevice Hsistatus StartDevicePrhdeviceobj deviceobject Hsistatussuccess if successful otherwise Hsistatusfailure Hsistatus SurpriseRemoval Hsistatus RemoveDevice Hsistatus rhHskRegisterMsgCallback RH-Aware Message Registration Definitions Int rhHskUnregisterMsgCallback Process Packet Callback DefinitionPcilocation pci Hsistatus rhHskSendMessage RH-Aware Send Message DefinitionUINT8* pBuf, int iLen, Pvoid pContext Length in bytes of the data packet being sent PPackett Alternate Hscsr Interfaces RH Device Driver Interface for Linux RH Device Driver Interface for Linux Non Bus Mastering Peripheral Design Guideline for Peripheral VendorsEBus Mastering DMA Capable Peripheral Support for Unmodified Standard Drivers Design Guideline for Peripheral Vendors Category ZT 5550 Functions Redundant Host Functions Porting ZT 5550 HA Applications to Picmg HAGetEthernetRo Porting ZT 5550 HA Applications to PicmgUting HASetEthernetRou RH Switchover on OS Crash RH Switchover on OS Crash CompactPCI Data Sheet ReferenceUser Documentation VxWorks Wind River* VxWorks Programmer’s Guide is available at Data Sheet Reference Impi Index Ipmi API Page This page intentionally left blank