From bd17fd844b4f074821b9d4c7bc86b9dc7f0e4a59 Mon Sep 17 00:00:00 2001 From: Barry Golden Date: Wed, 5 Aug 2015 18:07:36 -0700 Subject: Remove obsolete readme.htm --- ...EADFIRST_InstructionsForDevelopingHIDDriver.htm | 944 ------------- network/radio/HidSwitchDriverSample/README.htm | 1437 -------------------- usb/usbsamp/usbsamp.htm | 92 -- 3 files changed, 2473 deletions(-) delete mode 100644 network/radio/HidSwitchDriverSample/READFIRST_InstructionsForDevelopingHIDDriver.htm delete mode 100644 network/radio/HidSwitchDriverSample/README.htm delete mode 100644 usb/usbsamp/usbsamp.htm diff --git a/network/radio/HidSwitchDriverSample/READFIRST_InstructionsForDevelopingHIDDriver.htm b/network/radio/HidSwitchDriverSample/READFIRST_InstructionsForDevelopingHIDDriver.htm deleted file mode 100644 index 77351c56..00000000 --- a/network/radio/HidSwitchDriverSample/READFIRST_InstructionsForDevelopingHIDDriver.htm +++ /dev/null @@ -1,944 +0,0 @@ - - - - - - - - -HID USB FX2 Sample - - - - - - - - - - -
- -

Radio -Switch Driver Development

- -

 

- -

Sample -HID driver for Radio Management

- -

 

- -

There -are several steps that must be followed to create a HID driver for the hardware -wireless switch:

- -

 

- -

1)    Update System BIOS

- -

2)    Develop HID driver

- -

3)    Validate HID driver -functionality

- -

 

- -

 

- -

Update -System BIOS

- -

The system BIOS needs to be updated in order to -report the radio hardware button/switch to software – that is, the switch must -be exposed via ACPI.

- -

 

- -

BIOS must not control the radios directly, but must -rely on Windows 8 software to control the state of the radios via the HID -driver.

- -

 

- -

 

- -

Develop -the HID driver for the hardware wireless switch

- -

Use the HID driver sample to develop your -HID-compliant driver that communicates with your proprietary interface (embedded -controller) on the bottom edge and is wireless HID switch compliant on the -upper edge.

- -

 

- -

Important -note: if you are developing a HID driver for an A-B -switch, your proprietary embedded controller must report the correct state of -the switch at all times by sending a HID message to the HID driver, including -every time the PC is turned on back on. Reporting the state of the A-B switch -when the computer is turned back on is especially important in the case that -the switch changed states while the PC was in states S3/S4/S5.

- -

 

- -

 

- -

Validate -HID driver functionality

- -

Logo tests are available in the Windows Hardware -Certification Kit to validate the functionality of your HID driver.

- -

 

- -

 

- -

 

- -

 

- -
- - - - diff --git a/network/radio/HidSwitchDriverSample/README.htm b/network/radio/HidSwitchDriverSample/README.htm deleted file mode 100644 index ef09a38e..00000000 --- a/network/radio/HidSwitchDriverSample/README.htm +++ /dev/null @@ -1,1437 +0,0 @@ - - - - - - - - -HID USB FX2 Sample - - - - - - - - - -
- -

Radio -Switch Test Driver for OSR USB-FX2 Development Board

- -

 

- -

Before -developing the HID driver, please make sure you read the READFIRST document, -which indicates the steps that must be taken in order to correctly develop a -HID driver.

- -

 

- -

Sample HID -driver for Radio Management

- -

 

- -

This -sample demonstrates how to structure a HID driver for radio switches for the -OSR USB-FX2 Development Board.

- -

 

- -

On -Windows 8 and later, the hardware switch or button to control wireless -transmission and the global software switch (Airplane mode switch) in the Radio -Management User Interface must be synchronized. To ensure the hardware and -software switches that control radio transmission are synchronized, the -hardware switch or button must have a HID-compliant driver.

- -

 

- -

Switch -Pack Mapping

- -

 

- -

 

- - - - - - - - - - - - - - - - - - - - - - - - -
-

Switch

- 		-

1

- 		-

2

- 		-

3

- 		-

4

- 		-

5

- 		-

6

- 		-

7

- 		-

8

-
-

Mapping

- 		-

Mode Select

-

Bit 3

- 		-

Mode Select

-

Bit 2

- 		-

Mode Select

-

Bit 1

- 		-

-

- 		-

-

- 		-

-

- 		-

-

- 		-

Radio Switch

-
- -

 

- -

 

- -

Sample Language Implementation

- -

          C++

- -

 

- -

Prerequisites -for Installation

- -

1.    -Windows 8 Developer Preview x86

- -

2.    -Visual Studio 11 Developer Preview

- -

3.    -Windows 8 WDK

- -

 

- -

Building -the Driver

- -

1.    -Open the RadioSwitchHidUsbFx2.VcxProj

- -

2.    -Use Visual Studio 11 to build the project

- -

 

- -

Installing -the Driver

- -

 

- -

To -install the driver, you must:

- -
    -
  1. Build the driver using Visual Studio 11 Developer - Preview and copy the following installation files to a folder on your hard - drive:
    2. -
      -
    • RadioSwitchHidUsbFx2.inf
      • -
    • RadioSwitchHidUsbFx2.sys
      • -
    -
- -

 

- -
    -
  1. Plug in the device and do the following, depending on - the operating system that you are using:
    2. -
      -
        -
      1. Launch Device Manager by executing command devmgmt.msc in a command window, or from Hardware and Sound program group in Control Panel.
        2. -
      2. Select OSR USB-FX2 device from Other Devices category and click Update Driver Software… from right-click menu.
        3. -
      3. Select Browse my computer for - software and provide the location of the driver files.
        4. -
      4. Select Install this driver software anyway when - the Windows - Security dialog box appears.
        5. -
      5. After the driver is installed, you should see the - device in Device Manager under "Human Interface Devices".
        6. -
      -
    -
- -

Testing

- -

 

- -

Testing -Modes

- -

 

- -

The -driver supports five modes representing the valid combinations of HID -descriptors that we have defined for the USB forum.

- -

Modes -are selected using switches 1, 2, and 3 on the switch pack.

- -

 

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Switch

- 		-

1

- 		-

2

- 		-

3

- 		-

Mode

-
-

Mapping

- 		-

0

- 		-

0

- 		-

0

- 		-

Mode 1

-
-

 

- 		-

0

- 		-

0

- 		-

1

- 		-

Mode 1

-
-

 

- 		-

0

- 		-

1

- 		-

0

- 		-

Mode 2

-
-

 

- 		-

0

- 		-

1

- 		-

1

- 		-

Mode 3

-
-

 

- 		-

1

- 		-

0

- 		-

0

- 		-

Mode 4

-
-

 

- 		-

1

- 		-

0

- 		-

1

- 		-

Mode 5

-
-

 

- 		-

1

- 		-

1

- 		-

0

- 		-

Mode 1

-
-

 

- 		-

1

- 		-

1

- 		-

1

- 		-

Mode 1

-
- -

 

- -

The -Mode in use is displayed on the boards seven segment display.

- -

Mode -is determined at startup, so to change mode the board must be unplugged & -then re-connected

- -

 

- -

Mode -1 Radio Push Button

- -

In -this mode the radio switch (switch 8 on the switch pack) represents a momentary -push button.

- -

A -HID report is generated when the switch transitions to the On -state (switch down).

- -

 

- -

Mode -2 Radio Push Button & LED

- -

In -this mode the radio switch (switch 8 on the switch pack) represents a momentary -push button.

- -

A -HID report is generated when the switch transitions to the On -state (switch down).

- -

In -addition, the LED array will reflect the state of the Radio LED: either all on -or all off (note that the top 2 LEDs never illuminate as these are not wired -in).

- -

 

- -

Mode -3 Radio Slider Switch

- -

In -this mode the radio switch (switch 8 on the switch pack) represents an A-B -slider switch.

- -

A -HID report is generated in both cases: when the switch transitions to the On state (switch down) and to the Off state (switch up).

- -

 

- -

Mode -4 Radio Slider Switch & LED

- -

In -this mode the radio switch (switch 8 on the switch pack) represents an A-B -slider switch.

- -

A -HID report is generated in both cases: when the switch transitions to the On state (switch down) and to the Off state (switch up).

- -

In -addition the LED array will reflect the state of the Radio LED: either all on -or all off (note that the top 2 LEDs never illuminate as these are not wired -in).

- -

 

- -

Mode -5 LED only

- -

In -this mode the radio switch (switch 8 on the switch pack) is ignored.

- -

The -LED array will reflect the state of the Radio LED: either all on or all off -(note that the top 2 LEDs never illuminate as these are not wired in).

- -
- - - - diff --git a/usb/usbsamp/usbsamp.htm b/usb/usbsamp/usbsamp.htm deleted file mode 100644 index 015e7f28..00000000 --- a/usb/usbsamp/usbsamp.htm +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Bulk Usb - - - -

USBSAMP

- - -

-

Summary

- - -

The USBSAMP sample demonstrates how to perform full and high speed bulk and isochronous, and super speed bulk stream data transfers to a generic USB device using Windows Kernel Mode Driver Framework (KMDF). Super speed bulk transfer only works on Microsoft USB 3.0 stack. The sample also contains a console test application to initiate bulk, bulk stream & isochronouse transfers and -obtain information on the device's I/O endpoints. The application also -demonstrates how to use GUID-based device names and pipe names generated by the -operating system using the SetupDiXXX user-mode APIs.

- - -

Building the sample

-To build the sample driver and exe, you must first set up the DDK build environment on your host machine. The “Installation and Release Notes” in the Windows DDK has a complete description on how to do this. - -

    - - -
  1. - Run the build –ceZ command in the usbsamp directory to build usbsamp.sys and usbsamp.exe. - - - -
  2. - Copy KMDF coinstaller (wdfcoinstallerMMmmm.dll), usbsamp.sys, usbsamp.exe, and usbsamp.inf to a floppy disk or a temporary directory on the target system. -
-

- - -

Installing the Driver

- - Make sure your device has been programmed with the device VID/PID in the - USBSAMP.inf file. If not, edit the device VID, PID, and description text in the INF to - match your test board/device.

- After you plug the device: -

On Windows 7 and later:

-
    -
  • Bring up the device manager, find the device, right click on the device to "Update Driver Software.." -
  • Choose the "Browse my computer for driver software" option -
  • Click on "Let me pick from a list of device drivers on my computer" -
  • In the "Select your device's type from the list below", pick the "Show All Devices" -
  • Click on "Have Disk" and specify the target media or the directory where the INF and SYS files are copied and then hit the "Next" button. -
  • The system will scan the directory and pick up the matching INF and start the installation. You will get a Hardware Installation Warning dialog stating that your driver has not passed Windows Logo Testing. Hit "Continue Anyway" button. -
  • The system will copy the KMDF coinstaller (wdfcoinstallerMMmmm.dll), driver, INF file, load the driver and start the device. If every thing goes fine, you will get "Completing the Found New Hardware Wizard". Hit the "Finish" button and the installation is complete. -
  • You should be able to see the device in the Device manager under "Samples" device type -
- - -

Testing

- -You can use usbsamp.exe to test the device. This console application enumerates the interface registered by the driver and opens the device to send read, write or ioctl requests based on the command line options. -

-usbsamp.exe -u <-- Will dump all the descriptors and endpoint information. Always use it to dump the endpoint information to get correct pipe number for read and write -

-

-usbsamp.exe -r 1024 -w 1024 -c 100 -v <-- This command first writes 1024 bytes of data to bulk out endpoint (pipe1), and then reads 1024 bytes from bulk in endpoint (pipe0), and compares the read buffer with write buffer to see if they match. If the buffer contents match, it performs this operation 100 times. -

-

-To read and write to bulk endpoints you can run one or more of these commands simultaneously. When it reads or writes to super speed bulk endpoints with streams, the sample driver always uses the first underlying stream in that super speed bulk endpoints. The driver is multi-thread safe so it can handle multiple request at a time. -

-usbsamp.exe -r 65536 <--- by default, the device reads pipe0 -

-usbsamp.exe -w 65536 <--- by default, the device write to pipe1 -

-usbsamp.exe -r 65536 -i pipe02 <--- read 65536 bytes from pipe02 -

-usbsamp.exe -w 65536 -o pipe03 <--- write 65536 bytes to pipe03 - -

-To read and write to Isochronous endpoints you can run one or more of these commands simultaneously. -

-usbsamp.exe -r 510 -i pipe04 -

-usbsamp.exe -w 510 -o pipe05 -

-usbsamp.exe -w 1024 -o pipe05 -r 1024 -i pipe04 -c 100 -v - -

-When run with "-x" option for read and write, it skips validation of read and write data. - - \ No newline at end of file -- cgit v1.3.1