Command Operation Introduction | Ciprico Rimfire 3880 manual

Chapter 4 Command Operation

Page 4 - 2

Introduction

Introduction

The purpose of this chapter is to provide a comprehensive view of the RF3880 firmware operation and how it works with the hardware described in Chapter

2.By explaining the command structures and when to use them, this chapter explains how to use the board and it explains in general terms what a board driver must do.

Summary

This chapter discusses the following:

•Format of the basic Parameter and Status blocks from which command structures are built.

•Types of command structures—Single Command and Command List.

•The process for issuing a single command.

•The process for creating and starting a command list.

•Examples of both types of command structures.

•Implementation of the command structures within a ‘C’ routine.

•Types of commands you can issue—Pass-through and adapter Board- control commands.

•When to use each type of command.

The explanations in this chapter are most helpful to anyone designing a driver for the RF3880 adapter or attempting to understand an existing driver for the RF3500 family of adapters.

21020285 D

User’s Guide

Image 60

Ciprico Rimfire 3880 manual Command Operation Introduction

Contents

Rimfire 3880 Scsi Host Bus Adapter Page Page 21020285 D User’s Guide Preface Organization Initiator Mode Pass-through Commands Describes OrganizationOverview of the RF3880 User’s Guide Conventions Notational GraphicConventions Graphic Representation of Parameter Block Reference Documents 21020285 D Reference Documents Contents Scsi ID Status Block Format LUN LUN Table of Contents Description of Fields Command Identifier Diagnostic/Self-test 09H Table of Contents Table of Contents Introduction Summary Specifications Index O d u c t O v e r v i e w Latest Bus Specifications About Rimfire DesignBuffering scheme Product Overview About the Rimfire 3880 Design Target Mode Implementation Buffer Management What next? Product Overview What next? R d w a r e E s s e n t i a l s Introduction SummaryHardware Essentials Introduction Hardware Structure Description Intel 80186XLQLogic FAS Pipelined System Interface Data Buffer Block Diagram Hardware EssentialsGenerator blocks are part of the PSI Board Addressing Choosing an Address ModifierChoosing a VMEbus Address Hardware Essentials Board Addressing Hardware Port Addresses Overview of the PortsHardware Essentials Hardware Ports General Hardware Port Addresses Hardware Essentials Hardware Ports General Address Buffer Port Hardware Essentials Address Buffer PortAddress Buffer Port Writes Address Modifier Field Hardware Essentials Address Buffer Port Control Field Control Field of Address Buffer Port Single Command Structure Address Fields Channel Attention PortHardware Essentials Channel Attention Port Channel Format Channel Attention Status Port Reset Format Status Port ResetStatus Port Hardware Essentials Status Port Status Port Error Codes Status Port Error Codes Status Port General Format Status Port General Status Port Catastrophic Error Codes Chapter Hardware Essentials Status Port Reset Port Hardware Essentials Reset Port Descriptions of Port Usage Hardware Essentials Descriptions of Port Usage Hardware Essentials R d w a r e Installation Hardware Installation Introduction Overview Installation Process Hardware Installation Unpacking the Board Step Unpacking BoardShipping Damage Unpacking the Board Hardware Installation Jumpers and Termination Step Jumpers Termination Configuration Jumpers Default Jumper Settings Bus Request/ Grant Jumper Bus Request/Grant and Sysfail Jumpers Sysfail Jumper Example Base Address Jumper Settings ExampleAddresses For the Address Modifier Jumper Replacement Fuse Scsi bus Termination Hardware Installation Board Insertion General Steps Power-up Sequence Hardware Installation Apply power and observe LEDsMeaning LED’s Error Conditions Step Configure Connect Scsi Devices Hardware Installation Configure and Connect Scsi DevicesSelectable Options Options Scsi Cable Connector Cabling Hardware Installation M m a n d O p e r a t i o n Command Operation Introduction Command Operation What the Adapter must accomplish What the Adapter must accomplish Base ParameterBlock Parameter Command Descriptor Block Command Operation Base Status Block Base Status BlockStatus Block Format Base Status Block Command Operation Base Status Block Setting up Unit Options Multiple Status Blocks Single Command Structure Format Single Command StructureCommand Operation Single Command Structure Parameter Block Command Operation Single Command Structure Interrupt Bit-meanings of Interrupt Field Using a Single Command Structure Command Operation Using a Single Command Structure Some Example Single Commands Example Start Command List Board-controlCommand Operation Some Example Single Commands Command Identifier = 822F4H Command = 01H Interrupt = 0300H 21020285 D User’s Guide Example 2Inquiry Pass-through Command Example Pass-through command PB Command Operation Command Operation Some Example Single Commands Command List Structure Format Command List StructureDescription of the Fields Number of Parameter Blocks Number of Status BlocksParameter Block Space Status Block Space Creating Command List Structure Command Operation Creating the Command List Structure Using a Command List Structure Command GuidelinesCommand Operation Using a Command List Structure Index Guidelines Adding a Parameter Block Removing a Status Block Example ‘C’ Routines for Command List Command Operation Example ‘C’ Routines for Command List Stcdone Command Operation Example ‘C’ Routines for Command List Command Operation I t i a t o r t h r o u g h D e P a s s C o m m a n d s Initiator Mode Pass-through Commands Introduction Introduction Summary Command Format Initiator Pass- through Parameter Block FormatTarget ID Address Modifier Bit-meanings of Flags-1 Field Setting DBV DAT and DIR Bits Using Table Values Example DAT and DIR bit settingsDIR and DAT Settings, Vendor-unique Table of DAT DIR Automatic Settings DAT and DIR Automatic Settings 4EH Initiator Mode Pass-through Commands Flags-2 Bit-meanings of Flag-2 FieldMeaning of TAG Opts Bits Scsi Command Descriptor Block VME Memory AddressTransfer Count Message Format Pass-through Message Parameter BlockMessage Code Description of Fields Scsi Pass-through Status BlockBit-meanings of Flags Field Error Scsi Status Field during Unexpected Scsi Phase Bit-meanings of Scsi Status FieldMeaning of Status Byte Code Three signals. This is described below Meaning of Status Byte Unexpected Phase Default Ordering of Sense Bytes Up to 32 Sequential Sense BytesOrdering of 1st 16 Sequential Sense Bytes Example of Selected Sense Bytes Initiator Mode Pass-through Commands R g e t t h r o u g h D e P a s s C o m m a n d s Target Mode Pass-through Commands Introduction What is Target Mode? Target Mode Pass-through Commands Overview of Target Mode Target Mode Pass-through Commands Adapter must have a means of handling Scsi protocol issuesWhat must the adapter accomplish in Target Mode? Overview Special Target Mode Commands New commandsTarget Mode Enable Command Target Mode Disable Command Command Descriptor Block Group Codes Scsi Command Descriptor Block Groups Command Operation Sequence Events Enabling Target ModeTarget Mode Pass-through Commands Command Operation Sequence Events Receiving a Command From an Initiator Sequence of Events Responding to an Initiator Target Selection Data Structure Target Selection Data Structure Meaning of Flags Field Meaning of Scsi Flags Field Command Descriptor Block Length Identify Message ReceivedInitiator Identifier Message Bytes Received Semaphore Field Target Mode Response Command Target Mode Response Parameter BlockInitiator ID ⇒ Target Mode Response command Meaning of Response Control Flags Field Message Byte Status or 1st Message Byte Target Mode Response Command Status Block First TM Response Command Status BlockSecond TM Response Command Status Block Meaning of Status Block Flags Field Meaning of Command Status Flags Field Target Mode Error Sequence Codes Message Byte Received A r d c o n t r o l C o m m a n d s Board-control Commands Introduction Using the Reference Board-control Commands Using the Reference Board-control Commands General Status Block General Status BlockGeneral Status Block Format General Status Block List of Commands Board-control Commands List of CommandsBoard-control Commands Board-control Commands Start Command List 01H Start Command List Parameter BlockCommand List Memory Address Adapter ID Board-control Commands Start Command List 01H Interrupt Command Code Board-control Commands Stop Command List 02H Stop Command List Parameter Block Board-control Commands Identify 05H Identify Command Parameter BlockIdentify 05H Identify Command Status Block Identify Command Status BlockEngineering Revision Firmware Revision Board-control Commands Identify 05H Option Flags Option Flags Field Identify Status BlockAdapter Scsi ID Bits Day, Month, Year Board-control Commands Board Statistics 06H Board Statistics Command Parameter BlockBoard Statistics 06H Board-control Commands Board Statistics 06H Options Options Field Total Commands Processed Total Scsi Commands issued to an IDTarget Mode Selection Count Statistics Data Structure Command Format Description of Fields Board-control Commands General Options 07HGeneral Options Command Parameter Block General Options 07H Bus Throttle Bus Throttle Field ValuesSelect Flags Select Flags Byte Command code for this command is 07H Board-control Commands Unit Options 08H Unit Options Command Parameter BlockUnit Options 08H Unit Scsi ID Board-control Commands Unit Options 08H Disconnect Time-out Retry LimitRetry Control Retry Control Select Time-out Unit FlagsUnit Flags Initiator Mode Sense Count Selected Sense Bytes Example Use of Selected Sense Bytes Fields Example Selection of Sense Bytes Diagnostic/ Self-test 09H Board-control Commands Diagnostic/Self-test 09HDiagnostic/Self-test Parameter Block Diagnostics Command Test Flags Field Command code for this operation is 09H Diagnostic Command Status Block Flags ByteBit-meanings of Flags Byte in Status Block Target Mode Enable 0AH Board-control Commands Target Mode Enable 0AHTarget Mode Enable Parameter Block Pointer to the Target Selection Data Structure Meaning of Selection Interrupt Field Target Mode Disable 0BH Board-control Commands Target Mode Disable 0BHTarget Mode Disable Parameter Block Meaning of Flags-1 Field Board-control Commands Abort 0DH Command Identifier of CMD to be AbortedAbort 0DH Abort Parameter Block Scsi Hard Reset 10H Board-control Commands Scsi Hard Reset 10HScsi Hard Reset Parameter Block Board-control Commands Board Information 15H Board Information 15H Board-control Commands Board Information 15H Options Board Information Data StructureBoard Information Options Field Board Information Data Structure Board Information Select Flags Field Board-control Commands Board Information 15H Bus Throttle Board-control Commands Board Information 15H Option Flags RST Reset Jumper Board-control Commands Board Information 15H Termination Scsi Cfig BlockAdapter Base Model # Per Target Retry Limit Per Target Sense CountPer Target Device Flags Bit-meanings of Device Flags Field Per Target Synch Period Per Target Width Per Target Selected Sense Bytes Board-control Commands Extended Board Statistics 16H Extended Board Statistics 16HExtended Board Statistics Parameter Block Board-control Commands Extended Board Statistics 16H Options Extended Board Options Field Total Commands Issued Number of Scsi Parity ErrorsPer Scsi Target Number of Commands Extended Statistics Data Structure Board-control Commands Per Scsi Target Queue Full CountPer Scsi Target Maximum Queued Board-control Commands Extended Unit Options 18H Extended Unit Options 18HExtended Unit Options Parameter Block Extended Unit Options Data Structure Description of Fields Extended Unit Options Data Structure Bit-meanings of Retry Control Field Board-control Commands Extended Unit Options 18H Unit Flags Unit Flags of Extended Unit Options Board-control Commands Extended Unit Options 18H Selected Sense Bytes T a i l s o f U s a g e Details of Usage Introduction Need for Swapping Details of Usage Byte and Word SwappingExample of Memory Differences Variations in Intel and Motorola Memory Pass-through command Parameters Intel Ordering Motorola Ordering Command Structure Swapping RF3880 Swapping OptionsIntel Ordered Parameter Block Data Swapping Sharing TapesDual Initiators How to Use TaggedQueuing Tagged Details of Usage Tagged Queuing Choose a tag message Meaning of Flags-2 FieldRF3880 sends the tag message Usage Queue Tag NumbersQueue Full Status Message Reject Target Mode Usage Scsi Protocol Handling Scsi Bus Reset HandlingSelection Queue Target Mode Disable Command Handling Abort Command Handling Synchronous Data Transfer Requests Wide Data Transfer Requests Parity error conditions Message parity errorsInitiator-detected Error messages Target Routines Disconnect Privilege Message HandlingMessage Bytes Received from the Initiator 21020285 D User’s Guide User’s Guide 21020285 D Details of Usage Error codes Status Block Error Codes Appendix a Error Codes IntroductionCodes Reported in Status Block and Status Port Appendix a Error Codes Summary Error Codes Appendix a Error Codes 2BH A1H Status Port Error Codes Catastrophic Error CodesAppendix a Error Codes Status Port Error Codes Self-test Error Codes Diagnostic Command Self-test Status Port Error Codes 8CH B l e s a n d C o n n e c t o r s Appendix B Cables and Connectors Introduction Connector Appendix B Cables and Connectors Scsi ConnectorCable Connector Pin-outs for the RF3886 Maximum Cable Length VMEbus Connector Pinouts Appendix B Cables and Connectors VMEbus Connector PinoutsP1 Connector P2 Connector Retry Appendix B Cables and Connectors Specification s Appendix C Specifications Introduction Specifications Appendix C SpecificationsSpecifications for the Rf3880 Appendix C Specifications 21020285 D User’s Guide Fault s Appendix D Defaults Introduction Hardware Defaults Appendix D Defaults Hardware DefaultsHardware Defaults Jumpers Defaults for Hardware Ports Defaults Appendix D DefaultsCommand Defaults TAG Appendix D Defaults S i g n D i f f e r e n c e s Appendix E Design Differences Introduction Features no longer Supported Appendix E Design Differences Features no longer SupportedScatter/Gather Operations Byte and Word Swapping of Data Status Port Error Codes and Test Flags Appendix E Design Differences Implementation DifferencesWidth of Data Transfers on the VMEbus Extended Scsi ID’s Block Mode Transfers Scsi Data Widths How to Maximize Performance Odd-byte Addressing D e Index User’s Guide 21020285 D PSI Scsi ID Index Page 21020285 D