Summary | Intel ZT 4901 instruction

High Availability CompactPCI Device Drivers

5.2Summary

The intent of the HA CompactPCI device driver model is to leverage the native device driver infrastructure to supply a robust Hot Swap capability while limiting the non-proprietary device driver modifications. In order for a device driver to function effectively in a Redundant Host environment the driver should at a minimum implement the Hot Swap device driver infrastructure detailed in the following appendices of this manual:

•Appendix C, “HSK Device Driver Interface for VxWorks* 5.4”

•Appendix D, “RH Device Driver Interface for Linux* 2.4”

The specific implementation details vary between the supported operating systems, so choose the correct driver model for the operating system for which you are developing. To best leverage the Redundant Host capabilities it is recommended that some level of synchronization be implemented using the supplied device driver messaging infrastructure.

It is not necessary to implement all the supplied Redundant Host features for backplane device drivers to function in a High Availability architecture. There are some device implementations that require a device or bus segment to be reset when Host ownership changes. Using either the PICMG* 2.12 Redundant Host API or the IPMI API system information extension documented in the next chapter allows the bus segment to automatically reset the specified domain after the new Host has inherited the bus segment. To use these functions, see the Redundant Host switchover and slot information related APIs and the IPMI API for default Host activities.

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

Image 36

Intel ZT 4901 manual Summary

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 Introduction TerminologyFollowing terms are commonly used in this document Introduction Introduction High Availability Hardware Approach Processor Boards PCICIC RSS Processor Board Block Diagram Bridge Mezzanine RSS Host with Bridge Mezzanine Block Diagram Backplane High-Availability Software Approach Host ApplicationHost application System Management Backplane Device Drivers System Management Backplane Device Drivers Serviceability Host Application SoftwareGoals of the Host Application Portability Division of Labor Host Application Software Development Issues Graceful Switchover Hardened ApplicationsCode Modularity System Management Redundant Host APIIpmi API Fault Configuration Baseboard Management Controller Firmware EnhancementsHot Swap API Slot Control API Isolation Strategies Channel Definitions for ZT Ipmi RH Channel Commands RH Channel EnabledRH Channel Get RH BMC Address Request Response This page intentionally left blank High Availability CompactPCI Device Drivers Device Driver Design Device Driver States InitializationQuiesced Activation Adding High-Availability Functionality FindDevice Removed Add Device Resume Operations Suspend Operations Remove DeviceDriver Synchronization Summary RhGetHwDestinationHostAndReset Redundant Host APIIntel-Specific APIs RhSetHostName Redundant Host PICMG* 2.12 APIs Redundant Host APIHsistatussuccess Hsistatusinvalidparameter Definitions and Types Following topics specify each of the interface functions Minoralarm Majoralarm Criticalalarm Rhalarmseverity RESETREQUIRED, Resetnotrequired Unknown Rhslotneedsreset Initialization/Termination RhEnumerateInstancesHsistatusno Datadetected Hsistatusinsufficientbuffer RhOpen RhOpen Char *InstanceId Optional OUT Rhhandle *pHandleInstanceId RhEnumerateInstances RhClose RhGetInstanceIDRhClose in Rhhandle Handle Handle Handle Handle of the current session PInstanceID Domain and Host Information APIRhGetDomainCount RhGetDomainCount Rhhandle Handle OUT uint32 *pCount RhGetDomainNumbers Handle Handle of the current session PCountSystem RhGetDomainOwnership RhGetDomainSlotPath Domain is written as a null-terminated string SlotPathLengthCharacter HSISTATUSINSUFFICIENTBUFFER, this is the minimum RhGetDomainSlotCount RhGetDomainSlotsIs placed RhGetSlotDomain RhGetCurrentHostNumber RhGetHostCountRhGetCurrentHostNumber Rhhandle Handle OUT uint32 *pHost RhGetHostNumbers RhGetHostCount Rhhandle Handle OUT uint32 *pHostCountHandle Handle of the current session PHostCount RhGetHostName RhSetHostAvailability False RhGetHostAvailability Slot Information API RhGetDomainAvailabilityToHostRhGetPhysicalSlotInformation Hsinosuchdevice If the specified slot is emptyRhslotdescriptor Devices directly placed in the physical slots RhGetSlotChildInformation SlotPath+ FunctionNumber for the corresponding PCI-PCI bridge 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 RhPerformSwitchover RhGetSlotSwConnectionStatusInvalid session handle or the specified slot does not exist RhSetHwDestinationHost Handle Handle of the current session DestinationHostValue Rhnodestinationhost means no host should own Specified domains Rhnodestinationhost means no host owns the domains Notification, Reporting and Alarms RhEnableDomainStateNotificationRhGetHwDestinationHost RhEnableSwitchoverNotification DisconnectingDuring 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 ImbOpenDriver ImbCloseDriverImbDeviceIoControl ImbSendTimedI2cRequest LpvoidDword Lpdword ImbSendIpmiRequest ImbGetAsyncMessageAccesnstatus ImbIsAsyncMessageAvailable ImbRegisterForAsyncMsgNotificationImbUnregisterForAsyncMsgNotification EventId EventID handle returned once registered ImbGetLocalBmcAddr ImbSetLocalBmcAddr ImbGetIpmiVersion Byte imbGetIpmiVersionByte Current determined Ipmi version Slot Control API HsiOpenSlotControlHsiCloseSlotControl Hsistatusnomemory HsiGetSlotCount HsiGetBoardPresentSlot Control API HsiGetBoardHealthy Hsistatusnodatadetected HsiGetSlotPower Healthy HsiSetSlotPower HsiGetSlotReset HsiSetSlotReset HsistatusnotimplementedSlot Physical slot number HsiGetSlotM66Enable False 66 MHz operation is not enabled for the slotHsiapidef Hsistatus HsiSetSlotM66Enable HsiSetSlotEventCallback Handle Handle of the current session CallbackFunction Returned if the arguments or handle is invalid Void *HSISLOTEVENTCALLBACK HsisloteventinfostructHsisloteventinfo Demonstration Utilities Functional DescriptionUser Interface RH Interface Multiple Mode Capabilities Software Initiated HandoversHardware Initiated Failovers Demonstration Utilities Switchover Functions Notification, Reporting and AlarmsHost Domain Enumeration and Association Slot Information Fault Configuration Ipmi InterfaceIsolation Strategy Hot Swap Interface HS Functional Description Slot Information Structure PCI Tree Information Retrieval Flags Slot Control Interface Slot State Demonstration Utilities Software Installation Installing the Redundant Host Software KitLinux Installing RH Source RPM Source InstallationPatching and Rebuilding an RH-Enabled Kernel Software Installation Configuring the Redundant Host Infrastructure Making RH Configuration Changes1 /lib/modules/priBptd.o 2 /lib/modules/slotcntrl.o VxWorks Tornado II Setup 3 /CompactPCI-RH-1.0/app/lib4 /CompactPCI-RH-1.0/app/bin RedundantHostFunctionReturnValuesB Redundant Host Function Return Values Hsistatusnosuchbridge Hsistatusnosysrhtablefound Hsistatusnotavailible HsistatusnotreadyHsistatusobjectdoesnotexist Hsistatusoperationaborted Hsistatusunabletosendpacket HsistatusunsuccessfultranslationHsistatusunsupportedplatform 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 Hsistatus StartDevice Hsistatus StopDevicePrhdeviceobj deviceobject Hsistatussuccess if successful otherwise Hsistatusfailure Hsistatus RemoveDevice Hsistatus SurpriseRemoval RH-Aware Message Registration Definitions Hsistatus rhHskRegisterMsgCallback Process Packet Callback Definition Int rhHskUnregisterMsgCallbackPcilocation pci RH-Aware Send Message Definition Hsistatus rhHskSendMessageUINT8* pBuf, int iLen, Pvoid pContext 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 Design Guideline for Peripheral VendorsE Non Bus Mastering PeripheralBus Mastering DMA Capable 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 Porting ZT 5550 HA Applications to Picmg HAGetEthernetRoUting HASetEthernetRou RH Switchover on OS Crash RH Switchover on OS Crash Data Sheet Reference CompactPCIUser Documentation VxWorks Wind River* VxWorks Programmer’s Guide is available at Data Sheet Reference Index Impi Ipmi API Page This page intentionally left blank