Lucent Technologies USS-720 manual Ioctlabortpipe, Value Description, Bulkoutpipe, Bulkinpipe

Page 73

Preliminary User Guide, Rev. 2	USS-720
February 1999	USB Device Driver

4 I/O Control Codes (continued)

4.6 IOCTL_ABORT_PIPE

IOCTL_ABORT_PIPE cancels any pending transfers for the speciﬁed pipe. The pipe state and endpoint state are unaffected. Details regarding parameters and error codes follow.

4.6.1 Parameters

lpInBuffer—Points to a buffer that contains a single byte that speciﬁes one of the following values:

Value	Description

BULK_OUT_PIPE	Bulk Out pipe.

BULK_IN_PIPE	Bulk In pipe.

INTERRUPT_PIPE	Interrupt pipe.

nInBufferSize—Speciﬁes the size (in bytes) of the buffer pointed to by lpInBuffer. For this operation, this value should be 1.

lpOutBuffer—Points to an output buffer. Not used with this operation. Set to NULL.

nOutBufferSize—Speciﬁes the size (in bytes) of the buffer pointed to by lpOutBuffer. Not used with this operation. Set to zero.

lpBytesReturned—Points to a DWORD that receives the actual size (in bytes) of the data stored into lpOutBuffer. Not used with this operation.

4.6.2 Notes

None.

4.6.3 Error Codes

ERROR_INVALID_PIPE_INDEX—Speciﬁed pipe is invalid for this device instance or invalid for the current alter- nate interface setting.

STATUS_INVALID_PARAMETER—nInBufferSize cannot be zero.

STATUS_INSUFFICIENT_RESOURCES—Not enough memory to allocate a request to abort the pipe on this device instance.

Lucent Technologies Inc.

7-15

Image 73

Contents Information Manual, Rev September IntroductionTable of Contents September USB-to-IEEE Bridge Information Manual, Rev Evaluation Kit for USS-720IOCTL1284 Terminate USS-720 USB Device Driver Preliminary User GuideIOCTLSET1284REGISTER USS-720 USB Port Monitor Application Note Evaluation Kit Contents \SAMPLES Hardware RequirementsGetting Started Instructions OSR2.1 Cable Installation InstructionsWindows 98 Cable Installation Instructions Software UpdatesPlug and Play USB Driver and Port MonitorPort Creation Eeprom Lucent Technologies Inc In-System Design, Inc Lucent Technologies Microelectronics GroupUSB Applications Support September USS-720 Driver Software Object Code License Agreement Evaluation Kit SoftwareFebruary IntroductionLicensed Software USS-720 Software Use Agreement FebruaryFurnishing of Licensed Software OwnershipFebruary Software Use Agreement USS-720Agreement Prevails Warranty and IndemnityNothing Construed 04 ConﬁdentialityNonassignability PublicityAddresses IntegrationDisputes Applicable LawUSS720.INF USS720.SYSDocumentation USS-720 Software Use Agreement February Application Note, Rev February Software ComponentsPlug and Play Operation PnP Customer-Deﬁned DataPrinter Enumeration Installation Process Power ManagementOperating Systems Supported USB Hardware Types SupportedPrint Types Supported Printer Types SupportedPreliminary Data Sheet, Rev September FeaturesDescription Table of Contents Pin Information Preliminary Data Sheet, Rev USS-720USB-to-IEEE Parallel Port nSelectIn Signal Active-Low Parallel Port nAutoFd Signal Active-LowParallel Port nInit Signal Active-Low Parallel Port nAck Signal Active-LowUSB Port OverviewDevice Descriptor, Conﬁgurations, and Inter- faces Descriptor LocationsOnboard Device Descriptor USB-to- Ieee 1284 Bridge SeptemberDevice Descriptor Offset Field Size Value Description Conﬁguration Descriptor USB-to- IeeeBulk Out Endpoint Descriptor, I0A0E1 Interface DescriptorsBulk Out Endpoint Descriptor, I0A1E1 September USB-to-IEEE1284 BridgeBulk In Endpoint Descriptor, I0A1E2 Bulk In Endpoint Descriptor, I0A2E2 Bulk Out Endpoint Descriptor, I0A2E1Interrupt Endpoint Descriptor, I0A2E3 Requests PipesStandard Requests Get Port Status Data Bit Description Printer Class-Speciﬁc RequestsGET1284REGISTER Vendor-Speciﬁc RequestsSET1284REGISTER Register-Based Operation Ieee 1284 PortGET1284REGISTER Data Byte Register Data RegistersInterrupt Pipe Read Data Byte Register DataDefault Bit Symbol Bit Description Status Register Address Bit SymbolParallel Port nFault Signal Reserved Access Default Bit Symbol Bit Description Control Register Address Bit SymbolParallel Port nInit Signal USB-to-IEEE1284 BridgeUSS-720Instant USB ECP Command Register Address Bit Symbol Access Mode20 Description Extended Control Register Address Bit SymbolUSS-720 Control Register Address Bit Symbol USS-720 Setup Register Address Bit Symbol Interrupts External Crystal Connection External Circuitry RequirementsHigh Drive Mode Filter Bypass ModeSelf-Powered Mode Absolute Maximum Ratings Parameter Symbol Min UnitParameter Symbol Test Conditions Min Typ Max Unit Electrical CharacteristicsCapacitance Values Parameter Unit Clklo ClkhiSetup and Hold Input Timing Parameter Timing CharacteristicsOutput Delay Timing Parameter Min Max Unit Ordering Information Outline DiagramPin Mqfp Device Code Package ComcodeApplication Note February Description Port ParallelBridging USB to Typical Circuit Showing USSLucent Technologies Inc Preliminary User Guide, Rev February Signal DirectionsIOCTL1284 Setmode O File Functions InitializationPreliminary User Guide, Rev USS-720 February USB Device DriverCreateFile ReadFile Error CodesWriteFile DeviceIoControl CloseHandle Control Code Description O Control CodesParameters IOCTL1284 EcpfwdtorevIOCTL1284ECPREVTOFWD IOCTL1284 Ecpsetchannel IOCTL1284 Setmode Register Mode DescriptionIOCTL1284 Terminate Value Description IoctlabortpipeBulkoutpipe BulkinpipeIoctlcancelpiperequest IOCTLGET1284REGISTER ALTINTERFACE0 IoctlgetaltsettingALTINTERFACE1 ALTINTERFACE2Ioctlgetcapabilities Ioctlgetconfigurationdescriptor Ioctlgetdevicedescriptor Ioctlgetdeviceinstances Ioctlgetinterface Bit Meaning IoctlgetportstatusCommand Description IOCTLISSUEUSS720COMMANDByte Description IoctlreadinterruptpipeIoctlresetpipe IOCTLSET1284REGISTER Ioctlsetaltsetting Ioctlsoftreset Deviceinstanceheader O Control Data StructuresDeviceinstance Data StructureREGISTER1284, *PREGISTER1284 REGISTER1284ADVREGISTER1284, *PADVREGISTER1284 ADVREGISTER1284Lucent Technologies Inc USS-720 USB Port Monitor Printer Cable with Instant USB USS-720 Application Note USB Port Monitor FebruaryW98USS720EvalKit2402.zip to download the installation ﬁles Software Installation InstructionsApplication Note June Click on Enter LibrarySeptember MN99-052CMPR-1 Replaces MN97-061CMPR-04