C.0 Revision History

March 1, 2006

Added information on NWPA.H in Section 5.1.1, Required Header Files.

Added value 37 to the npaCompletionCode table of CDI_Complete_Message.

Added a note about not calling HAI_Deactivate_Bus during specific events of NPA_Register_For_Event_Notification.

Updated the description of busSpecificInfo in NPAB_Get_Bus_Specific_Info, busType in NPAB_Get_Bus_Type, and readData in NPAB_Read_Config_Space.

Clarified address pointers in CSetB, CSetD, and CSetW.

Added information about %x and %X specifiers not being permitted in NetWare 3.12 to OutputToScreen.

Updated the parameter descriptions of sprintfWithPointer and added an Example section.

Updated the description of parameter0 in HAM_Return_Device_Info (Function 0x02) and parameter0 in HAM_Recovery_Reset (Function 0x07).

Added value 4 (Port reset) to HAM_Recovery_Reset (Function 0x07) and updated the SATA table in HAM_Return_Device_Status (Function 0x0B).

Changed return values for Magazine Load (0x001D - 0x0005), Magazine Eject (0x001D - 0x0006), Return Changer Media Mapping (0x001C - 0x0002), Return Magazine Media Mapping (0x001D - 0x0002), Magazine Select Media (0x001D - 0x0003), Magazine Deselect Media (0x001D - 0x0004), and Magazine Unload (0x001D - 0x0006).

Updated the description of attributeFlags in DeviceInfoStruct, controlInfo in HACBStruct, supportedTargetIDs and supportedUnitNumbers in HAMInfoStruct, and flags, parameter0, and parameter1 in NPAOptionStruct.

Added the capabilities field and its description to HACBStruct.

June 1, 2005

Added the Section 3.6.1, Flow of Events section.

Updated the Remarks section of HAI_Deactivate_Bus.

Updated the Fields and Remarks sections of DeviceInfoStruct.

Changed the 0x0000000F bit of reasonFlag to ALERT_DEVICE_REMOVED for CDI_Object_Update.

March 2, 2005

Added a description of cdmBindHandle to the Parameters section for CDI_Bind_CDM_To_Object.

Added information about SATA (Serial ATA) technology. Added hacbType 4 to Host Adapter Interface Routines. Added host bus adapter value 0x0004 to CDI_Register_CDM. Added the SATA (Serial ATA) Adapter Command Structure (HACB Type 4) information.

Updated the capabilities description in the IDE-ATA Adapter Command Structure (HACB Type 2) section of HACBStruct.

Removed duplicate text from the Remarks section of Case 2 for HAM_Scan_For_Devices (Function 0x01).

Changed the title of the former Miscellaneous Functions to Section 6.6, I/O Port Functions.

Changed the parameter descriptions of CStrCmp, CStrCpy, and CStriCmp to refer to NULL-terminated strings.

Made minor edits throughout all sections.

June 9, 2004

Updated the parameters (and their descriptions) of NPA_CDM_Passthru.

Added a return value of 2 “The switch to real mode is already in progress” to HAI_Disable_Real_Mode_Access.

October 8, 2003

Changed the blocking status of NPA_Cancel_Thread, updated the Remarks section of NPA_Register_HAM_Module, and added a note to the Remarks section of NPA_SpinLockDisable, NPA_SpinTryLockDisable, and DisableAndRetFlags.

Added option UNREGISTERED_SLOT 0x0040 to NPAOptionStruct.

Updated two figures.

Removed documentation for NPA_NATA_Is_Supported.

February 2003

Added documentation for HAM_Return_Port_Info (Function 0x0C).

Made minor changes throughout.

May 2002

Changed all FLAG_ON values from 67108864 to 0x04000000.

Updated the documentation for NPA_System_Alert, NPA_SpinLockDisable, NPA_Register_For_Event_Notification, and DeviceInfoStruct.

Changed the parameter values in Case 2 of HAM_Scan_For_Devices (Function 0x01).

September 2001

Restructured Section 7.0, HACB Type Zero Functions, Section 8.0, CDM Message Control Functions, and Section 9.0, CDM Message I/O Functions into numerical order.

Updated the definition of EventBlockStruct and HACBStruct.

Changed documentation of NPA_CDM_Passthru to show it is a Blocking function.

Added note iv to Section 3.2, Operational Overview.

Updated the Section 3.6, Software Hot Replacement section.

Added "Interrupts disabled" to HAM_Abort_HACB.

Deleted all occurrences of "Code using spin lock is expected to be non-pageable."

Added three return values to NPAB_Search_Adapter.

Designated specific values in the NPAOptionStruct table of "Option Types vs. Parameter Definitions" as being hex values.

Updated the definition of the Check Condition in Section 11.1, HACB Completion Codes.

Switched Steps 1 and 2 in HAM_Instance_Unload (Function 0x09) of the Remarks section.

Changed the Return Values of HAM_Return_Device_Status (Function 0x0B).

Updated the parameter descriptions of HAM_Suspension_Notification (Function 0x0A).

Added alternative text to figures.

Version 3.04f

February 2001

In NPA_Register_With_EventBus, exchanged remarks for the registrationName and eventName parameters.

Version 3.04d

May 2000

Change occurences of MM_OK to ERROR_NO_ERROR_FOUND.

Resized multiple tables for better usability.

In HAM_ISR, corrected syntax.

In NPA_System_Alert, modified alertMask, targetNotifyMask, alertID, and alertClass parameters.

Document CDM Message Control Function Media Detect (0x0002).

In HACBStruct, corrected syntax.

In the table on HACB Control Flag Values, added information to flag value 0x00000010.

Version 3.04b

January 2000

Updated template. Corrected minor spelling, grammar, and formatting errors.

Clarified information about Type 3 HACB functions.

Updated PCCardInfoStructure field descriptions and added remarks.

Updated PCIInfoStructure field descriptions and modified remarks.

Version 3.04

September 1999

Retitled document from NetWare Peripheral Architecture (NWPA) Functional Specification and Developer's Guide to NetWare Peripheral Architecture. Changed references of Media Manager Functional Specification and Developer's Guide to Media Manager. Added new field descriptions in Structures chapters.

Version 3.03 (continued)

Created new NWPA Values chapter (Chapter 8) and moved Appendix B, Handling HACB Completion Codes, and applicable tables and values from other chapters in the documentation into the NWPA Values chapter.

Created new Revision History chapter (Chapter 10). and moved the revision history information from the old Preface and Revision Tracking Section from the old Chapter 1, About This Guide, into the Revision History chapter. Chapter 10.

Removed Appendix D, The NetWare Debugger, and referenced the NetWare Debugger documentation in the NDK.

Removed Appendix C LDI/DDI Specification Supplements, and referenced the LDI/DDI specification documentation in the NDK.

Add Bit 0x00002000 and description to the attributesFlags table in the DeviceInfoStuct

Version 3.01a

Appendix E: Instructions for writing Multi-Processor enabled Hams was added.Chapter 7: Modified parameters for CDI_Execute_CDMMessage().

Added the following APIs to support multi-processor host adapter drivers (HAMs).NPA_Inc();NPA_Dec();NPA_Add();NPA_Sub();NPA_Bts();NPA_Btr();NPA_Xchg();NPA_SpinLockInit();NPA_SpinLock();NPA_SpinTryLock();NPA_SpinUnlock();NPA_SpinLockDisable();NPA_SpinTryLockDisable();NPA_SpinUnlockRestore();NPA_MutexAlloc();NPA_MutexFree();NPA_MutexLock();NPA_MutexTryLock();NPA_MutexUnlock();

Version 3.00b

Clarified references to applications in the spec. An application is always an NLM.

Corrected references to “virtualAddress” in the HACB (changed to vDataBufferPtr).

Chapter 3: Fixed the Scatter/Gather conflict in section 3.4. Scatter/Gather is mandatory, not optional.

Chapter 4: Fixed incorrect reference for hacbCompletion values in section 4.2.2. paragraph B.3, values are listed in Appendix B not in Chapter 3.C.

Chapter 6: Added Interrupt_Safe_Execute flag to HAMInfoStruct.

Chapter 7: Added parameter definitions for real mode events under NPA_Register_For_Event_Notification.Made clarifications to NPA_Unregister_Module - use during unload, not instance unload.Added text to clarify why NPA_Unregister_Options is used.Deleted bit settings for MP Aware.Added function 5 to NPA_Config.Added new API - CDI_Return_Object_Info

Chapter 8: Added functions 0x0A and 0x0B to HACB type 0.

Appendix B: Changed the return value for “Device Not Active” (0x0007).

Appendix C: HPROD and SPROD added to DDI/LDI Specification Addendum.

Version 3.00a (continued)

NPA_Register_With_EventBus esr and callBack gain reference to Chapter 6. NPAB_Get_Bus_Tag and NPAB_Get_Bus_Name no longer supported. NPAB_Get_Bus_Type, NPAB_Get_Card_Config_Info, NPAB_Get_Instance_Number, NPAB_Read_Config_Space, NPAB_Scan_Bus_Info, NPAB_Search_Adapter, NPAB_Write_Config_Space got updated return codes. NPAB_Get_Bus_Specific_Info, NPAB_Get_Bus_Type, NPAB_Get_Card_Config_Info, NPAB_Get_Inique_Identifer, NPAB_Scan_Bus_Info, NPAB_Search_Adapter, got CardBus support. NPAB_Get_Hin_From_HINName and NPAB_Get_HINName_From_HIN added. NPA_HACB_Passthru hacbType request description updated. NPA_Interrupt_Control not used for disabling interrupts

Chapter 8: 0x00000020 Device appeared, 0x80000000 Vendor Specific AEN and event explanations added to HAM_Queue_AEN_HACB.Chapter 9: Random Read, Random Write, Random Write Once, bufferLength is in BYTEs.

Chapter 10: DoRealModeInterrupt. and DoRealModeInterrupt32 support removed for IW3 DisableAndRetFlags use clarified.

Appendix A: NLMLINKR(P) changed to NLMLINKX. Note on page A-2 expanded. Figure A-1: removed extraneous code.

Appendix B: Changed to HACB Completion Codes.

Appendix C: No technical changes.

Appendix D: Added.

Version 2.32

Document Update to support Version 2.32 of NWPAMP.NLM.General Changes: Typos, printer formatting errors, etc. were corrected. New logo was integrated into document.

Chapter 1: No technical changes.

Chapter 2: Novell Event Bus synopsis added.2.2.3 Hot Plug capability added.

Chapter 3: Added 0x00000400 Master_HACB_Flag and specific malformed errors to Table 3-1.

Chapter 4: Changed Processing HACB Requests 4.2.2.B.4.b to correct sequence of execution and added flowcharts. Added section 4.3.6.1 Scanning all LUNs. Section 4.3.4.2 new step 8 inserted. 4.2.1.2 HIN awareness note added.

Chapter 5: No technical changes. Added flowcharts.

Chapter 6: HAMInfoStruct flags received another flag for Hot Plugable Hardware awareness.EventBlockStruct added.

Chapter 7: Added NPA_Return_DeviceHandle. NPA_Get_EventBlocks, NPA_Return_EventBlocks, NPA_Register_With_EventBus. NPA_Unregister_With_EventBus, and NPA_Send_Event APIs.NPAB_ Return Values clarified. Added reasonFlag to HAI_Object_Update.

Chapter 8: Added Important box to HACB Type 0 function 1 case 2.

Chapter 9: No technical changes.

Chapter 10: No technical changes.

Appendix A: No technical changes.

Appendix B: Moved 0x80030005-A to 0x00030005-A. Added (0x0003000B)

Appendix C: No technical changes.

Index: Added to document.

Version 2.31

Document Update to support Version 2.31 of NWPAMP.NLM.General Changes. Typos, printer formatting errors, etc. were corrected.

References to NWPACompletionCode or NPACode were changed to npaCompletionCode throughout the document.

Chapter 1: Updated Section 1.5 to reflect current version numbers.

Chapter 2: No technical changes.

Chapter 3: Updated HACBStruct definition to match NPA.H version of this structure and corrected/added parameter descriptions to match the updated structure. Added Function 9 HAM_Instance_Unload to Table 3-3.

Chapter 4: Added HAM_Instance_Unload description to Section 4.1.4. Added new Figure 4-1. Updated paragraph 4.2.1 to reflect addition of Figure 4-1. Removed NWDIAG option for HACB completions in Section 4.2.2. Clarified implementation in Section 4.2.4 part B.2.a regarding aborting outstanding HACBs. Clarified note in Section 4.3.1. Updated Table 4-1. Added Adapter attention AEN type to Section 4.3.2. Added Section 4.3.10 Instance Unload for HAMs.

Chapter 5: Added footnote to Section 5.3.2.2. Added Adapter attention AEN type to Section 5.3.6.

Chapter 6: Updated HACBStruct definition to match NPA.H version of this structure. Added slotOption parameter to HAMInfoStruct. Updated Table 6-1 in NPAOptionStruct.

Chapter 7: Added the following function descriptions: HAI_Disable_Real_Mode_Access(), HAI_Enable_Real_Mode_Access(), and NPA_Config(). Updated descriptions of the following functions: CDI_Blocking_Execute_HACB(), CDI_Execute_HACB(), CDI_Non_Blocking_Execute_HACB(), CDI_Queue_Message(), CDI_Register_CDM(), CDM_Abort_CDMMessage(), NPA_CDM_Passthru(), NPA_Micro_Delay(), NPA_Parse_Options(), NPA_Register_CDM_Module(), NPA_Register_HAM_Module(), and NPA_Unregister_Module().

Chapter 8: Added Adapter attention to HAM_Queue_AEN_HACB. Added Adapter initialize to HAM_Recovery_Reset. Added HAM_Instance_Unload description. Deleted redundant Scan Completion Code table and referenced Table 5-1.

Chapter 9: No technical changes.

Chapter 10: No technical changes.

Version 2.3

Document update to support NetWare® upgrade of NWPA. Corrected reported typos and printing errors in documentation and made the following changes.Chapter 1: Added Revision Tracking section.

Chapter 2: Added WWW address for location of electronic document download. Updated Paragraphs 2.2 and 2.3.2.3.

Chapter 3: Described an additional HAM to CDM use of the control_Info field. Deleted requirements for the HACB Type = 3 request throughout the entire document. Updated Table 3.2 HACB Type values to reserve HACB types from the range of 0x0003 to 0x01FF for use by NetWare, and to reserve the range from 0x0200 to 0xFFFF for vendor use. Updated Table 3.3 to change the name of HAM_Return_HAM_Info to HAM_Return_Bus_Info (also in Chapter 4 and Chapter 8), include two Type zero HACBs (functions 7 and 8), and reserve for NetWare all values from 0x00000009 to 0xFFFFFFFF. Updated Figure 3-1 to include field names for buffer pointers.

Chapter 4: Changed implementation of HAM_Set_IDE_Device_Config to mandatory for IDE-ATA devices. Removed requirements for NWDIAG. Changed vendorID terminology to novellAssignedModuleID to clarify that this ID must be unique for each module (HAM or CDM), not for each vendor (also in Chapter 7 in NPA_CDM_Passthru()). Added Device disappeared case to events under Asynchronous Event Notification. Clarified requirements for Software Hot Replacement, and made Autodetection mandatory for HAMs and CDMs.

Chapter 6: Updated definition of parameters in CDMMessageStruct to correspond to Media Manager implementation. Corrected definition of the hamSpaceDef user defined area in HACBStruct (also in Chapter 3.) Changed parameter name of cardTargetID to adapterTargetID and defined default values for supportedTargetIDs and supportedUnitNumbers in HAMInfoStruct. Updated description of NPAOptionStruct to clarify usage of parameters, and added a table showing the relationship between parameters and option types.

Version 2.1d

Corrected typos, format errors, etc. in preparation for Developer Services release of document.

Added NPA_Get_Version_Number () API.

Added Blocking flag option for NPA_Allocate_Memory() to Version 4.x NWPA.

Replaced Figure 4-1 with update notice. Figure 4-1 will be updated for the next document release, as noted in paragraph 4.2.1.

Updated HAM Device Queue State column in Appendix B to reflect addition of the No_Freeze_Queue_Flag option for CDMs.

Updated DeviceInfoStruct parameter definitions to add SCSI Synchronous Information.

Updated NPAOptionStruct parameter definitions.

Deleted HAI_Get_Slot() and HAI_Get_Slot_Name() APIs to reflect changes in the NBI specification.

Updated the description for NPA_Interrupt_Control().

Added 10 microsecond resolution note to NPA_Micro_Delay().

Added Thread Context information to Inx, InBuffx, Outx and OutBuffx APIs.

Changed the identifying prefix for NBI APIs from HAI_ to NPAB_ to separate them from the existing Host Adapter specific APIs. Updated the references to these APIs throughout the document to reflect this change. Re-sorted Chapter 7 to place the NPAB_ APIs in alphabetical order.

Deleted the NPABusHandle parameter from all of the NPAB_ APIs.

Corrected the return value types for CCmpB() and CCmpD() in Chapter 10 from BYTE to LONG.

Updated Draft portion of Appendix C to reflect changes in the LDI/DDI specification.

Added InvertLong() function definition to Chapter 10.

Updated Appendix A to include a new link.def file example and to list the include files needed for HAMs and CDMs.

Version 2.1c (continued)

Updated Case 0 and Case 1 scan requirements.

Corrected references from .dsk output file to .ham output file in Appendix A.

Updated Chapter 10 OS Support Routines to describe currently implemented OS routines, including correcting the SetFlags() routine to a VOID from a LONG.

Added Appendix C LDI/DDI Specification Supplement and Related Material.

Deleted the Index from this revision.

Version 2.1a

Generally, most of the changes were clarifications of existing concepts, not additions of new concepts.

Throughout the document, NPABindHandle was changed to CDIBindHandle.

Figure 2-1 was changed.

Figure 2-2 was removed.

Section 3.3.1, CDMPassThrough command block: the structure of the block was changed. The BufferLength, Buffer, and ReturnParameter fields were replaced with the following: BYTE Reserved5[12].

The reason is that the data that was originally assigned to these fields is now part of the main HACB, DataBufferLength, VDataBufferPtr, control_Info, respectively.

Chapter 5 and Chapter 7, the CDM MessageStruct:The definition of the CDMMessageStruct was changed. The QueueLink field was redefined, and a new 1-LONG field was appended to the structure. The former QueueLink field and the new field were combined to make the following: LONG CDMReserved[2].

A new bit was defined in the upper WORD of the CDMMessageStruct's Function field, the CACHE_OKAY_BIT.

Section 6.2.1: Clarified CDM use of the NPA's command line parser.

Section 6.2.2: Reference to CDMTypeStruct was removed. The change regarding this structure was documented in version 1.x to 2.0 history.

Reorganization of Chapter 6. Some of the section numbers were changed. The Error Handling section was moved from Special Topics to the Operational Overview.

Special Topics: Added pertinent information regarding Removable-media device and magazine support.

Version 2.0

LONG HACBPutHandle replaces struct HACBStruct* as a stack parameter passed to the following APIs (see Chapter 8): CDI_Abort_HACB()CDI_Blocking_Execute_HACB()CDI_Execute_HACB()CDI_Return_HACB()

LONG *NPAHandle is an additional stack parameter required in CDI_Bind_CDM_To_Object() (see chapter 8)

LONG NPAHandle is an additional stack parameter required in the following APIs (see chapter 8): CDI_Chain_Message()CDI_Object_Update()CDI_Unbind_CDM_From_Object()

CDMTypeStruct has been eliminated from the specification. This was replaced by the Types parameter in the CDI_Register_CDM() API. See chapter 8.

CDMTypeStruct has been eliminated from the specification. This was replaced by the Types parameter in the CDI_Register_CDM() API. See chapter 8.

CDMTypeStruct has been eliminated from the specification. This was replaced by the Types parameter in the CDI_Register_CDM() API. See chapter 8.

Queue state indicator moved from ControlFlags field of HACB to most significant bit of hacbCompletion field. See hacbCompletion field in section 3.3.2.

The ControlFlags field name in the HACB was changed to control_Info, and its purpose was redefined. See control_Info field in section 3.3.2.

Optional HAM software hot replacement. See section 4.3.4 and HAM_Software_Hot_Replace() in chapter 8.

NWDIAG support required in HAM. See section 4.3.5.

Scatter_Gather and Hardware_Verify bits defined for Function field of CDM message structure. See Function field in section 5.2.2.

Entry points that allow NLM applications to get and set device attributes adde d to the CDM. See sections 6.1.2, 6.2.5, AttributeInfoStruct in chapter 7 and CDI_Register_Object_Attribute in chapter 8.

Asynchronous Event Notification. For HAM, see section 4.3.2 and HAM_Queue_AEN_HACB() in chapter 9. For CDM see section 6.3.5.

Buffer mismatches. See section 6.3.6.

Version 1.x

Initial release.