Manuals / Intel / Computer Equipment / Network Router

Intel ZT 4901 manual RH Device Driver Interface for Linux

Models: ZT 4901

1 136

Download 136 pages 35.65 Kb

Page 123

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 FiguresDate Revision Description Revision HistoryThis 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 DiagramBackplane RSS Host with Bridge Mezzanine Block DiagramHigh-Availability Software Approach Host ApplicationHost application System Management Backplane Device Drivers System Management Backplane Device Drivers Portability ServiceabilityHost Application Software Goals of the Host ApplicationHost Application Software Division of LaborDevelopment Issues Graceful Switchover Hardened ApplicationsCode Modularity System Management Redundant Host APIIpmi API Slot Control API Fault ConfigurationBaseboard Management Controller Firmware Enhancements Hot Swap APIChannel Definitions for ZT Isolation StrategiesIpmi 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 DriversActivation Device Driver StatesInitialization QuiescedRemoved Adding High-Availability FunctionalityFind DeviceResume Operations Add DeviceSuspend Operations Remove DeviceDriver Synchronization Summary RhSetHostName RhGetHwDestinationHostAndResetRedundant Host API Intel-Specific APIsHsistatusinvalidparameter Redundant Host PICMG* 2.12 APIsRedundant Host API HsistatussuccessFollowing topics specify each of the interface functions Definitions and TypesMinoralarm Majoralarm Criticalalarm Rhalarmseverity RESETREQUIRED, Resetnotrequired Unknown Rhslotneedsreset Hsistatusinsufficientbuffer Initialization/TerminationRhEnumerateInstances Hsistatusno DatadetectedRhEnumerateInstances RhOpenRhOpen Char *InstanceId Optional OUT Rhhandle *pHandle InstanceIdHandle RhCloseRhGetInstanceID RhClose in Rhhandle HandleRhGetDomainCount Rhhandle Handle OUT uint32 *pCount Handle Handle of the current session PInstanceIDDomain and Host Information API RhGetDomainCountRhGetDomainNumbers Handle Handle of the current session PCountSystem RhGetDomainSlotPath RhGetDomainOwnershipHSISTATUSINSUFFICIENTBUFFER, this is the minimum Domain is written as a null-terminated stringSlotPathLength CharacterRhGetDomainSlotCount 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 RhSetHostAvailabilityRhGetHostAvailability Slot Information API RhGetDomainAvailabilityToHostRhGetPhysicalSlotInformation Devices directly placed in the physical slots HsinosuchdeviceIf the specified slot is empty RhslotdescriptorBy two characters from the set ‘0’..’9’, ‘A’..’F’ RhGetSlotChildInformationSlotPath + FunctionNumber for the corresponding PCI-PCI bridgeIf there are no child devices below the specified bridge Handle Handle of the current session PhysSlotPCI buses in the system Switchover Scenarios and Theory of Operation Switchover APIPartially Cooperative Switchover Hostile Switchover RhPrepareForSwitchoverHsistatusrequestdenied Hsistatussuccess returned in the case of success RhCancelPrepareForSwitchoverRhGetDomainSwConnectionStatus 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 ownRhnodestinationhost means no host owns the domains Notification, Reporting and Alarms RhEnableDomainStateNotificationRhGetHwDestinationHost RhEnableSwitchoverNotification DisconnectingDuring software connection and disconnection Switchovers in which it participates RhEnableSwitchoverRequestNotificationRhEnableUnsafeSwitchoverNotification Indicates is the depth of the device below the physical slot Device in unsafe stateRhDisableNotification Handle Handle of the current session NotificationType Hot Swap API Hot Swap API ImbOpenDriver ImbCloseDriverImbDeviceIoControl Lpdword ImbSendTimedI2cRequestLpvoid DwordImbSendIpmiRequest ImbGetAsyncMessageAccesnstatus EventId EventID handle returned once registered ImbIsAsyncMessageAvailableImbRegisterForAsyncMsgNotification ImbUnregisterForAsyncMsgNotificationImbSetLocalBmcAddr ImbGetLocalBmcAddrCurrent determined Ipmi version ImbGetIpmiVersionByte imbGetIpmiVersion ByteHsistatusnomemory Slot Control APIHsiOpenSlotControl HsiCloseSlotControlHsiGetSlotCount HsiGetBoardPresentSlot Control API Hsistatusnodatadetected HsiGetBoardHealthyHealthy HsiGetSlotPowerHsiGetSlotReset HsiSetSlotPowerHsiSetSlotReset 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 FunctionVoid *HSISLOTEVENTCALLBACK HsisloteventinfostructHsisloteventinfo RH Interface Demonstration UtilitiesFunctional Description User InterfaceDemonstration Utilities Multiple Mode CapabilitiesSoftware Initiated Handovers Hardware Initiated FailoversSlot Information Switchover FunctionsNotification, Reporting and Alarms Host Domain Enumeration and AssociationFault Configuration Ipmi InterfaceIsolation Strategy HS Functional Description Hot Swap InterfacePCI Tree Information Retrieval Flags Slot Information StructureSlot State Slot Control InterfaceDemonstration Utilities Software Installation Installing the Redundant Host Software KitLinux Software Installation Installing RH Source RPMSource Installation Patching and Rebuilding an RH-Enabled Kernel2 /lib/modules/slotcntrl.o Configuring the Redundant Host InfrastructureMaking RH Configuration Changes 1 /lib/modules/priBptd.oVxWorks Tornado II Setup 3 /CompactPCI-RH-1.0/app/lib4 /CompactPCI-RH-1.0/app/bin RedundantHostFunctionReturnValuesB Redundant Host Function Return Values Hsistatusnosysrhtablefound HsistatusnosuchbridgeHsistatusoperationaborted HsistatusnotavailibleHsistatusnotready HsistatusobjectdoesnotexistHsistatusuptinsertionfailed HsistatusunabletosendpacketHsistatusunsuccessfultranslation HsistatusunsupportedplatformThis page intentionally left blank HSK Driver Object Declaration HSK Device Driver Interface for VxWorksHSK Device Driver Interface for VxWorks HSK Device Information StructureCompatlistcheckdevice HSK Driver Instantiation Code SegmentPrhdeviceobj AddDevice Redundant Host-Aware Callback DefinitionsHsistatussuccess if successful otherwise Hsistatusfailure Hsistatus StartDeviceHsistatus StopDevice Prhdeviceobj deviceobjectHsistatus SurpriseRemoval Hsistatus RemoveDeviceHsistatus rhHskRegisterMsgCallback RH-Aware Message Registration DefinitionsProcess 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 pContextPPackett Alternate Hscsr InterfacesRH 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 PeripheralDesign Guideline for Peripheral Vendors Category ZT 5550 Functions Redundant Host Functions Porting ZT 5550 HA Applications to PicmgHASetEthernetRou Porting ZT 5550 HA Applications to PicmgHAGetEthernetRo UtingRH Switchover on OS Crash RH Switchover on OS Crash Wind River* VxWorks Programmer’s Guide is available at Data Sheet ReferenceCompactPCI User Documentation VxWorksData Sheet Reference Impi IndexIpmi API Page This page intentionally left blank