Ioctlcancelpiperequest | Lucent Technologies USS-720 guide

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

4 I/O Control Codes (continued)

4.7 IOCTL_CANCEL_PIPE_REQUEST

IOCTL_CANCEL_PIPE_REQUEST cancels the current request on the speciﬁed pipe by ﬂushing the pipe and canceling any outstanding requests on the pipe. Details regarding parameters and error codes follow.

4.7.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.7.2 Notes

None.

4.7.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.

7-16	Lucent Technologies Inc.

Image 74

Lucent Technologies USS-720 manual Ioctlcancelpiperequest

Contents

Introduction Information Manual, Rev September Table of Contents Information Manual, Rev Evaluation Kit for USS-720 September USB-to-IEEE Bridge IOCTLSET1284REGISTER USS-720 USB Device Driver Preliminary User GuideIOCTL1284 Terminate USS-720 USB Port Monitor Application Note Evaluation Kit Contents Hardware Requirements \SAMPLES OSR2.1 Cable Installation Instructions Getting Started Instructions Software Updates Windows 98 Cable Installation Instructions Port Creation USB Driver and Port MonitorPlug and Play Eeprom Lucent Technologies Inc Lucent Technologies Microelectronics Group In-System Design, Inc USB Applications Support September February Evaluation Kit SoftwareUSS-720 Driver Software Object Code License Agreement Introduction Furnishing of Licensed Software USS-720 Software Use Agreement FebruaryLicensed Software Ownership USS-720 February Software Use Agreement Nothing Construed Warranty and IndemnityAgreement Prevails 04 Conﬁdentiality Addresses PublicityNonassignability Integration Applicable Law Disputes Documentation USS720.SYSUSS720.INF USS-720 Software Use Agreement February Software Components Application Note, Rev February Printer Enumeration Customer-Deﬁned DataPlug and Play Operation PnP Operating Systems Supported Power ManagementInstallation Process USB Hardware Types Supported Printer Types Supported Print Types Supported Description FeaturesPreliminary Data Sheet, Rev September Table of Contents USB-to-IEEE Preliminary Data Sheet, Rev USS-720Pin Information Parallel Port nInit Signal Active-Low Parallel Port nAutoFd Signal Active-LowParallel Port nSelectIn Signal Active-Low Parallel Port nAck Signal Active-Low Device Descriptor, Conﬁgurations, and Inter- faces OverviewUSB Port Descriptor Locations Device Descriptor Offset Field Size Value Description USB-to- Ieee 1284 Bridge SeptemberOnboard Device Descriptor USB-to- Ieee Conﬁguration Descriptor Interface Descriptors Bulk Out Endpoint Descriptor, I0A0E1 Bulk In Endpoint Descriptor, I0A1E2 September USB-to-IEEE1284 BridgeBulk Out Endpoint Descriptor, I0A1E1 Interrupt Endpoint Descriptor, I0A2E3 Bulk Out Endpoint Descriptor, I0A2E1Bulk In Endpoint Descriptor, I0A2E2 Standard Requests PipesRequests Printer Class-Speciﬁc Requests Get Port Status Data Bit Description SET1284REGISTER Vendor-Speciﬁc RequestsGET1284REGISTER Ieee 1284 Port Register-Based Operation Interrupt Pipe Read Data RegistersGET1284REGISTER Data Byte Register Data Byte Register Data Parallel Port nFault Signal Reserved Status Register Address Bit SymbolDefault Bit Symbol Bit Description Parallel Port nInit Signal Control Register Address Bit SymbolAccess Default Bit Symbol Bit Description USB-to-IEEE1284 Bridge USS-720Instant USB ECP Command Register Address Bit Symbol Access Extended Control Register Address Bit Symbol Mode20 Description USS-720 Control Register Address Bit Symbol USS-720 Setup Register Address Bit Symbol Interrupts External Circuitry Requirements External Crystal Connection Self-Powered Mode Filter Bypass ModeHigh Drive Mode Absolute Maximum Ratings Parameter Symbol Min Unit Capacitance Values Parameter Unit Electrical CharacteristicsParameter Symbol Test Conditions Min Typ Max Unit Clklo Clkhi Output Delay Timing Parameter Min Max Unit Timing CharacteristicsSetup and Hold Input Timing Parameter Pin Mqfp Outline DiagramOrdering Information Device Code Package Comcode Application Note February Description Bridging USB to Typical Circuit Showing ParallelPort USS Lucent Technologies Inc Signal Directions Preliminary User Guide, Rev February IOCTL1284 Setmode Preliminary User Guide, Rev USS-720 February InitializationO File Functions USB Device Driver CreateFile Error Codes ReadFile WriteFile DeviceIoControl CloseHandle O Control Codes Control Code Description IOCTL1284 Ecpfwdtorev Parameters IOCTL1284ECPREVTOFWD IOCTL1284 Ecpsetchannel Register Mode Description IOCTL1284 Setmode IOCTL1284 Terminate Bulkoutpipe IoctlabortpipeValue Description Bulkinpipe Ioctlcancelpiperequest IOCTLGET1284REGISTER ALTINTERFACE1 IoctlgetaltsettingALTINTERFACE0 ALTINTERFACE2 Ioctlgetcapabilities Ioctlgetconfigurationdescriptor Ioctlgetdevicedescriptor Ioctlgetdeviceinstances Ioctlgetinterface Ioctlgetportstatus Bit Meaning IOCTLISSUEUSS720COMMAND Command Description Ioctlreadinterruptpipe Byte Description Ioctlresetpipe IOCTLSET1284REGISTER Ioctlsetaltsetting Ioctlsoftreset Deviceinstance O Control Data StructuresDeviceinstanceheader Data Structure REGISTER1284 REGISTER1284, *PREGISTER1284 ADVREGISTER1284 ADVREGISTER1284, *PADVREGISTER1284 Lucent Technologies Inc USS-720 USB Port Monitor USS-720 Application Note USB Port Monitor February Printer Cable with Instant USB Application Note June Software Installation InstructionsW98USS720EvalKit2402.zip to download the installation ﬁles Click on Enter Library September MN99-052CMPR-1 Replaces MN97-061CMPR-04