RH Device Driver Interface for Linux | Intel ZT 4901 specs

RH Device Driver Interface for
Linux* 2.4	D

The High-Availability RH architecture leverages both the capabilities of the native hot-pluggable Linux driver model and the Hot-Swap Kit drivers to offer ultra-quick takeovers while maintaining maximum device serviceability. The Linux hot-pluggable driver model not only provides hot extraction of backplane devices, but also dynamic device insertion. The Linux hot-pluggable driver model is a stated driver architecture that is used by RH drivers to survive system switchovers with a minimum of service interruptions. For further details on this driver model please refer to the Linux Device Drivers Book version 2 published by O’Reilly and Associates. Specifically the Hot- Pluggable driver extension is documented in the PCI Interface chapter.

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

123

Image 123

Intel ZT 4901 manual RH Device Driver Interface for Linux

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 Introduction TerminologyFollowing terms are commonly used in this document Introduction Introduction High Availability Hardware Approach Processor Boards PCICIC Bridge Mezzanine RSS Processor Board Block Diagram Backplane RSS Host with Bridge Mezzanine Block Diagram High-Availability Software Approach Host ApplicationHost 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 Graceful Switchover Hardened ApplicationsCode Modularity System Management Redundant Host APIIpmi API Slot Control API Fault ConfigurationBaseboard Management Controller Firmware Enhancements Hot Swap API Channel Definitions for ZT Isolation Strategies Ipmi RH Channel Commands RH Channel EnabledRH 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 Suspend Operations Remove DeviceDriver 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 RhGetDomainNumbers Handle Handle of the current session PCountSystem RhGetDomainSlotPath RhGetDomainOwnership HSISTATUSINSUFFICIENTBUFFER, this is the minimum Domain is written as a null-terminated stringSlotPathLength Character 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 False RhSetHostAvailability RhGetHostAvailability Slot Information API RhGetDomainAvailabilityToHostRhGetPhysicalSlotInformation 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 RhPerformSwitchover RhGetSlotSwConnectionStatusInvalid 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 Notification, Reporting and Alarms RhEnableDomainStateNotificationRhGetHwDestinationHost RhEnableSwitchoverNotification DisconnectingDuring 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 ImbOpenDriver ImbCloseDriverImbDeviceIoControl Lpdword ImbSendTimedI2cRequestLpvoid Dword ImbSendIpmiRequest ImbGetAsyncMessageAccesnstatus EventId EventID handle returned once registered ImbIsAsyncMessageAvailableImbRegisterForAsyncMsgNotification ImbUnregisterForAsyncMsgNotification ImbSetLocalBmcAddr ImbGetLocalBmcAddr Current determined Ipmi version ImbGetIpmiVersionByte imbGetIpmiVersion Byte Hsistatusnomemory Slot Control APIHsiOpenSlotControl HsiCloseSlotControl HsiGetSlotCount HsiGetBoardPresentSlot Control API Hsistatusnodatadetected HsiGetBoardHealthy Healthy HsiGetSlotPower HsiGetSlotReset HsiSetSlotPower HsiSetSlotReset HsistatusnotimplementedSlot Physical slot number HsiGetSlotM66Enable False 66 MHz operation is not enabled for the slotHsiapidef Hsistatus HsiSetSlotM66Enable Returned if the arguments or handle is invalid HsiSetSlotEventCallbackHandle Handle of the current session Callback Function Void *HSISLOTEVENTCALLBACK HsisloteventinfostructHsisloteventinfo 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 Fault Configuration Ipmi InterfaceIsolation Strategy HS Functional Description Hot Swap Interface PCI Tree Information Retrieval Flags Slot Information Structure Slot State Slot Control Interface Demonstration Utilities Software Installation Installing the Redundant Host Software KitLinux 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 VxWorks Tornado II Setup 3 /CompactPCI-RH-1.0/app/lib4 /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 Process Packet Callback Definition Int rhHskUnregisterMsgCallbackPcilocation 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