Manuals / Intel / Computer Equipment / Network Router

Intel ZT 4901 manual Hot Swap API

Models: ZT 4901

1 136

Download 136 pages 35.65 Kb

Page 78

Hot Swap API

This page intentionally left blank.

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

Image 78

Intel ZT 4901 manual Hot Swap API

Contents

Technical Product Specification Intel NetStructureTM ZT 4901 High Availability SoftwarePage Contents Hot Swap API Demonstration Utilities Figures TablesRevision History Date Revision DescriptionThis 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 MezzanineRSS Host with Bridge Mezzanine Block Diagram BackplaneHigh-Availability Software Approach Host ApplicationHost application System Management Backplane Device Drivers System Management Backplane Device Drivers Goals of the Host Application ServiceabilityHost Application Software PortabilityDivision of Labor Host Application SoftwareDevelopment Issues Graceful Switchover Hardened ApplicationsCode Modularity System Management Redundant Host APIIpmi API Hot Swap API Fault ConfigurationBaseboard Management Controller Firmware Enhancements Slot Control APIIsolation Strategies Channel Definitions for ZTIpmi 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 DesignQuiesced Device Driver StatesInitialization ActivationDevice Adding High-Availability FunctionalityFind RemovedAdd Device Resume OperationsSuspend Operations Remove DeviceDriver Synchronization Summary Intel-Specific APIs RhGetHwDestinationHostAndResetRedundant Host API RhSetHostNameHsistatussuccess Redundant Host PICMG* 2.12 APIsRedundant Host API HsistatusinvalidparameterDefinitions and Types Following topics specify each of the interface functionsMinoralarm Majoralarm Criticalalarm Rhalarmseverity RESETREQUIRED, Resetnotrequired Unknown Rhslotneedsreset Hsistatusno Datadetected Initialization/TerminationRhEnumerateInstances HsistatusinsufficientbufferInstanceId RhOpenRhOpen Char *InstanceId Optional OUT Rhhandle *pHandle RhEnumerateInstancesRhClose in Rhhandle Handle RhCloseRhGetInstanceID HandleRhGetDomainCount Handle Handle of the current session PInstanceIDDomain and Host Information API RhGetDomainCount Rhhandle Handle OUT uint32 *pCountRhGetDomainNumbers Handle Handle of the current session PCountSystem RhGetDomainOwnership RhGetDomainSlotPathCharacter Domain is written as a null-terminated stringSlotPathLength HSISTATUSINSUFFICIENTBUFFER, this is the minimumRhGetDomainSlotCount 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 FalseRhGetHostAvailability Slot Information API RhGetDomainAvailabilityToHostRhGetPhysicalSlotInformation 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 bridgePCI buses in the system Switchover API Switchover Scenarios and Theory of OperationPartially Cooperative Switchover RhPrepareForSwitchover Hostile SwitchoverHsistatusrequestdenied RhCancelPrepareForSwitchover Hsistatussuccess returned in the case of successRhGetDomainSwConnectionStatus RhPerformSwitchover RhGetSlotSwConnectionStatusInvalid session handle or the specified slot does not exist Value Rhnodestinationhost means no host should own RhSetHwDestinationHostHandle Handle of the current session DestinationHost Specified domainsRhnodestinationhost means no host owns the domains Notification, Reporting and Alarms RhEnableDomainStateNotificationRhGetHwDestinationHost RhEnableSwitchoverNotification DisconnectingDuring software connection and disconnection RhEnableSwitchoverRequestNotification Switchovers in which it participatesRhEnableUnsafeSwitchoverNotification Device in unsafe state Indicates is the depth of the device below the physical slotRhDisableNotification Handle Handle of the current session NotificationType Hot Swap API Hot Swap API ImbOpenDriver ImbCloseDriverImbDeviceIoControl Dword ImbSendTimedI2cRequestLpvoid LpdwordImbSendIpmiRequest ImbGetAsyncMessageAccesnstatus ImbUnregisterForAsyncMsgNotification ImbIsAsyncMessageAvailableImbRegisterForAsyncMsgNotification EventId EventID handle returned once registeredImbGetLocalBmcAddr ImbSetLocalBmcAddrByte ImbGetIpmiVersionByte imbGetIpmiVersion Current determined Ipmi versionHsiCloseSlotControl Slot Control APIHsiOpenSlotControl HsistatusnomemoryHsiGetSlotCount HsiGetBoardPresentSlot Control API HsiGetBoardHealthy HsistatusnodatadetectedHsiGetSlotPower HealthyHsiSetSlotPower HsiGetSlotResetHsiSetSlotReset HsistatusnotimplementedSlot Physical slot number HsiGetSlotM66Enable False 66 MHz operation is not enabled for the slotHsiapidef Hsistatus HsiSetSlotM66Enable Function HsiSetSlotEventCallbackHandle Handle of the current session Callback Returned if the arguments or handle is invalidVoid *HSISLOTEVENTCALLBACK HsisloteventinfostructHsisloteventinfo User Interface Demonstration UtilitiesFunctional Description RH InterfaceHardware Initiated Failovers Multiple Mode CapabilitiesSoftware Initiated Handovers Demonstration UtilitiesHost Domain Enumeration and Association Switchover FunctionsNotification, Reporting and Alarms Slot InformationFault Configuration Ipmi InterfaceIsolation Strategy Hot Swap Interface HS Functional DescriptionSlot Information Structure PCI Tree Information Retrieval FlagsSlot Control Interface Slot StateDemonstration Utilities Software Installation Installing the Redundant Host Software KitLinux Patching and Rebuilding an RH-Enabled Kernel Installing RH Source RPMSource Installation Software Installation1 /lib/modules/priBptd.o Configuring the Redundant Host InfrastructureMaking RH Configuration Changes 2 /lib/modules/slotcntrl.oVxWorks Tornado II Setup 3 /CompactPCI-RH-1.0/app/lib4 /CompactPCI-RH-1.0/app/bin RedundantHostFunctionReturnValuesB Redundant Host Function Return Values Hsistatusnosuchbridge HsistatusnosysrhtablefoundHsistatusobjectdoesnotexist HsistatusnotavailibleHsistatusnotready HsistatusoperationabortedHsistatusunsupportedplatform HsistatusunabletosendpacketHsistatusunsuccessfultranslation HsistatusuptinsertionfailedThis page intentionally left blank HSK Device Driver Interface for VxWorks HSK Driver Object DeclarationHSK Device Information Structure HSK Device Driver Interface for VxWorksHSK Driver Instantiation Code Segment CompatlistcheckdeviceRedundant Host-Aware Callback Definitions Prhdeviceobj AddDevicePrhdeviceobj deviceobject Hsistatus StartDeviceHsistatus StopDevice Hsistatussuccess if successful otherwise HsistatusfailureHsistatus RemoveDevice Hsistatus SurpriseRemovalRH-Aware Message Registration Definitions Hsistatus rhHskRegisterMsgCallbackProcess Packet Callback Definition Int rhHskUnregisterMsgCallbackPcilocation pci UINT8* pBuf, int iLen, Pvoid pContext RH-Aware Send Message DefinitionHsistatus rhHskSendMessage Length in bytes of the data packet being sentAlternate Hscsr Interfaces PPackettRH 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 DriversDesign Guideline for Peripheral Vendors Porting ZT 5550 HA Applications to Picmg Category ZT 5550 Functions Redundant Host FunctionsUting Porting ZT 5550 HA Applications to PicmgHAGetEthernetRo HASetEthernetRouRH Switchover on OS Crash RH Switchover on OS Crash User Documentation VxWorks Data Sheet ReferenceCompactPCI Wind River* VxWorks Programmer’s Guide is available atData Sheet Reference Index ImpiIpmi API Page This page intentionally left blank