Renesas H8SX1664 User manual

REG10J0134-0100
Renesas Starter Kit for H8SX1664
USB Sample Code User's Manual
RENESAS SINGLE-CHIP MICROCOMPUTER
H8SX FAMILY
Rev.1.00 Renesas Technology Europe Ltd.
Revision date 08.January.2008 www.renesas.com

Table of Contents
Table of Contents.................................................................................................................................................. ii
Chapter 1. Preface..................................................................................................................................................3
Chapter 2. Introduction............................................................................................................................................4
Chapter 3. Development Environment....................................................................................................................5
3.1. Sample Code Configuration.........................................................................................................................5
3.2. Target Sample Code Options .......................................................................................................................5
3.3. Host Application Software ............................................................................................................................5
Chapter 4. USB Stack (Target)................................................................................................................................6
4.1. Hardware Abstraction Layer.........................................................................................................................6
4.2. USBCore ......................................................................................................................................................7
4.3. Human Interface Device Class.....................................................................................................................8
4.4. Communication Device Class ......................................................................................................................9
4.5. Mass Storage Class ...................................................................................................................................10
Chapter 5. Applications.........................................................................................................................................11
5.1. Introduction to Applications ........................................................................................................................11
5.2. Human Interface DeviceApplication..........................................................................................................11
5.3. Communications Device Class Application................................................................................................13
5.4. Mass Storage Class Demonstration...........................................................................................................16
5.5. LibUSB .......................................................................................................................................................17
Chapter 6. Additional Information..........................................................................................................................19
ii

Chapter 1. Preface
Cautions
This document may be, wholly or partially, subject to change without notice.
All rights reserved. No one is permitted to reproduce or duplicate, in any form, a part or this entire document without the written
permission of Renesas Technology Europe Limited.
Trademarks
All brand or product names used in this manual are trademarks or registered trademarks of their respective companies or
organisations.
Copyright
© Renesas Technology Europe Ltd. 2007. All rights reserved.
© Renesas Technology Corporation. 2007. All rights reserved.
© Renesas Solutions Corporation. 2007. All rights reserved.
Website: http://www.renesas.com/
Glossary
ADC Analog to Digital Converter USB Universal Serial Bus
CPU Central Processing Unit DAC Digital to Analog Converter
DMA Direct Memory Access E10A “E10A for Starter Kits” debug module
FDT Flash Development Tool RSK Renesas Starter Kit
LED Light Emitting Diode LCD Liquid Crystal Display
3

Chapter 2.Introduction
TheRSKUSBsamplecodeprovidesabasisforadevelopertoaddUSBdevicefunctionalitytoasystem. Itincludessampleapplicationsfor
the three most common USB Device classes*:-
•Human Interface Device (HID)
•Communication Device Class - Abstract Control Model (CDC-ACM)
•Mass Storage Class (MSC)
InadditiontothethreedefinedUSBclassesaLibUSBsampleisincluded.LibUSBisanopensourceprojectwiththeaimofprovidingalibrary
that a user application can utilise to access a USB device regardless of operating system. A sample using a Microsoft Windows XP host is
provided.
The embedded software is available as source written in ANSI C and does not require an operating system.
The host applications software is also available as source written for MS Windows using VisualC++.
This manual describes the technical details of the RSKhardware. The Quick Start Guide andTutorial Manual provide details of the software
installation and debugging environment.
ClassesSamples
HID CDC MSC
USB Core Driver
HAL
USB Hardware
HID
Demo CDC Demo MSC Demo
USB Stack
LibUSB
Demo
Figure 1 - Embedded SW, including Layers of USB Stack
*
See specific sections for details. Tested with a USB Host PC running MS Windows XP SP2. HID and
LibUSB samples both include a PC Application.
4

Chapter 3.Development Environment
3.1.Sample Code Configuration
TheSamplecode isprovidedasaproject generatorwiththeRSK.Tocreate thesamplecodeprojectfollowtheinstructionsintheRSKQuick
Start Guide.
When created the sample code will contain the source for both the Host and Target projects, including any configuration driver files.
3.2.Target Sample Code Options
When developing USB software it is useful to be able to get debug information out at runtime without stopping code from running such as
when stepping in a debugger. Allmodules of the USB Stacksoftware include debug messages that can be utilised in a system that supports
printf. The sample Applications all support printf and the output is viewable via the serial port of the RSK. To view the serial output the
following settings are required:
Baud: 19200. Data: 8 Bit. Parity: None. Stop Bits: 1. Flow: None.
The level of debug message can be set using the #define VERBOSE_LEVEL. This is described in the file usb_common.h in the USBStack
directory. Note that a high level of debug messages can significantly slow down the system.
3.3.Host Application Software
To build the Microsoft Visual C++ Applications you will need to have the appropriate Windows Software Development Kit (SDK) and the
Windows Driver Development Kit (DDK) installed. These kits provide access to the library functions to access USB devices and are
available directly from Microsoft.
We have provided the links to the current locations for XP based downloads below however we cannot guarantee the suitability or accuracy
of these links. Both must be installed to be able to build the application, we suggest installing the SDK first.
www.microsoft.com/downloads
Windows SDK
Windows DDK
5

Chapter 4.USB Stack (Target)
The USB software is implemented in the form of a USB stack comprising of three layers.
At the top of the stack are the USB Device Classes consisting of HID, CDC and MSC which are all described later.
In the middle is a core layer (USBCore) that handles standard device requests. At the bottom is a hardware abstraction layer (HAL) that
provides a hardware independent API for the upper layers.
This modular design means this software can be still be used even if developing a proprietary USB interface. For example a proprietary
module could be implemented by calling functions directly exposed by both the USBHAL API and USBCore API.
4.1.Hardware Abstraction Layer
The HAL is a hardware specific layer that provides a non-hardware specific API. The HAL supports the following transfer modes:
Control (Setup, Data IN/OUT, Status)
Bulk (IN and OUT)
Interrupt (IN)
Some HAL implementations may not be able to support all these modes but the H8SX1664 implementation does.
Here is a list of the functions that make up the USBHAL API.
Name Description
USBHAL_Init Initialise the HAL. Register callback functions. If using the USB Core layer then this is done
automatically.
USBHAL_Config_Get Get the current HAL configuration.
USBHAL_Config_Set Set the current HAL configuration.
USBHAL_Control_ACK Generate an ACK on the Control IN pipe. (Used following a setup packet)
USBHAL_Control_IN Send data on the Control IN pipe. (Used following a setup packet)
USBHAL_Control_OUT Receive data on the Control OUT pipe. (Used following a setup packet)
USBHAL_Bulk_IN Send data on the Bulk IN pipe.
USBHAL_Bulk_OUT Receive data on the Control OUT pipe.
USBHAL_Interrupt_IN Send data on the Control IN pipe.
USBHAL_Reset Reset this module. (Following an error).
USBHAL_Control_Stall Stall the control pipe. (Used following a setup packet)
USBHAL_Bulk_IN_Stall Stall the Bulk IN pipe.
USBHAL_Bulk_OUT_Stall Stall the Bulk OUT pipe.
USBHAL_Interrupt_IN_Stall Stall the Interrupt IN pipe.
USBHALInterruptHandler The system must be setup so that this gets called when any USB Interrupt occurs.
The HAL module consists of the following files:-
usb_hal.c
usb_hal.h.
usb_common.h
6

4.2.USBCore
TheUSBCore layerhandlesstandardUSBrequests commonto allUSBdevicesduring theenumeration stage.Thismeansthata developer
canconcentrate onanyclass orvendor specificimplementation. TheUSBCorerequiresinitialisingwith thedescriptors specificto the device
being implemented. It uses the USBHAL, which it initialises, to access the particular HW.
The following Get_Descriptor requests are handled:
Device
Configuration
String
Language ID (Only a single language ID is supported and this is currently English)
Manufacturer
Product
Serial Number
The USBCDC API consists of a single function called ‘USBCORE_Init’. This initialises the USBCore and the HAL. In addition to passing
device descriptors to this function it also requires call back functions for the following conditions:
A Setup packet has been received that this layer can’t handle. This enables a higher layer to handle class or vender specific requests.
A Control Data Out has completed following a setup packet that is being handled by the layer above.
The USB cable has been connected or disconnected.
An unhandled error has occurred.
The HAL module consists of the following files:-
usb_core.c
usb_core.h.
usb_common.h
7

4.3.Human Interface Device Class
The HID class as the name suggests is commonly used for things like keyboards, mice and joysticks where a human’s action is causing the
need for communication. However thisdoes not need to be the case.The HID class is suitable for any device wherethe communication can
be achieved by sending data in ‘reports‘ of a predefined size where the data transfer rate is not critical.
TheHIDclass hasbeensupportedbyMicrosoftWindows98onwards. Supportisbothat kernellevelanduser level.WhenaHIDtypedevice
is plugged into a Windows PC it will be automatically recognised and Windows will load its own drivers for it, so there is no need to develop
a custom Windows driver or even a Windows ‘inf’ file.
This implementation of the HID class supports a single IN report and a single OUT report. Both Interrupt IN and Control IN (via Get_Report)
transfers are supported for sending a report to the host. Reports from the host must use Control OUT (via Set_Report).
Here are the functions that make up the USBHID API.
Name Description
USBHID_Init Initialise the HID module. Register a callback functions to be called when a report is received from the host.
Provide the initial contents of a report to send to the host. Initialises the Core and HAL layers.
USBHID_ReportIN Send a report to the host using Interrupt IN transfer.
The HID module consists of the following files:-
usb_hid.c
usb_hid.h.
usb_descriptors.c
usb_descriptors.h
usb_common.h
8

4.4.Communication Device Class
TheCDCACMallowsahosttoseeadeviceasastandardserial(COM)port.Thisisparticularlyusefulwhenworkingwithlegacyapplications
that use serial communications. Bulk IN and Bulk OUT transfers are used for all non-setup data.
TheCDC moduleutilisesthe USBCorelayerfor theprocessing ofallstandard requests.Inadditionitprocessesthefollowing classrequests.
GET_LINE_CODING
SET_LINE_CODING (As required by MS HyperTerminal)
SET_CONTROL_LINE_STATE
The CDC class is supported by MS Windows so there is no need to develop a custom Windows kernel driver. However a custom ‘inf’ file is
required, the sample CDC application includes such a file. When a CDC ACM device is plugged into a Windows PC an additional (virtual)
COM port will become available that applications can use just like a standard COM port.
Here are the functions that make up the USBCDC API.
Name Description
USBCDC_Init Initialise the CDC module. This also initialises the Core and HAL layers.
USBCDC_IsConnected Returns the connected status of the device.
USBCDC_WriteString A blocking function that sends a string to the host.
USBCDC_PutChar A blocking function that sends a character to the host.
USBCDC_GetChar A blocking function that gets a character from the host.
USBCDC_Write A blocking function that sends a supplied data buffer to the host.
USBCDC_Write_Async Starts an asynchronous write of a data buffer to the host. A call back is used to signal when the operation
has completed.
USBCDC_Read A blocking function that reads from the host into a supplied data buffer.
USBCDC_Read_Async Starts an asynchronous read from the host into a data buffer. A call back is used to signal when the
operation has completed.
USBCDC_Cancel Cancel any asynchronous operations that are pending.
The CDC module consists of the following files:-
usb_cdc.c
usb_cdc.h.
usb_descriptors.c
usb_descriptors.h
usb_common.h
9

4.5.Mass Storage Class
The MSC class has become a very popular way for devices, such as cameras and USB Pens, to share data with PCs. The reason for the
success is that when the device is plugged in to a host PC it appears to the PC as just another drive and therefore users can use familiar
applicationssuchas WindowsExplorer toaccess thedata. FromWindows 2000 onwardsthe MSCclass hasbeen supportedwithnoneed
for custom drivers or ‘inf’ files.
Bulk IN and Bulk OUT transfers are used for all non-setup data.
TheMSC moduleutilisesthe USBCorelayerfor theprocessingof allstandardrequests.In additionit processesthefollowing classrequests.
BULK_ONLY_MASS_STORAGE_RESET
GET_MAX_LUN
In addition to supporting the standard USB protocol a MSC device must support a set of SCSI commands. All SCSI commands are sent
packaged up in a Command Block Wrapper (CBW) within a Bulk OUT transfer. A data stage may follow in either direction and then to
complete the SCSI command the device sends a status response in the form of a Command Status Wrapper (CSW). The following SCSI
commands are supported:
INQUIRY
READ_CAPACITY10
READ10
REQUEST_SENSE
TEST_UNIT_READY
WRITE10
VERIFY10
PREVENT_ALLOW_MEDIUM_REMOVAL (Optional)
MODE_SENSE6 (Optional, Limited support)
The USBMSC API consists of a single function called ‘USBMSC_Init’. This initialises the MSC module and also the USBCore and HAL
layers.
This implementation of the MSC class directly accesses a simple RAM Disk block driver that uses 30KB of the RSK’s RAM. i.e. There is no
separation between MSC class and MSC application. Hence when using a different memory this will need to be changed to access that
rather than the sample RAM Disk.
The MSC module consists of the following files:-
usb_msc.c
usb_msc.h.
usb_msc_scsi.c
usb_msc_scsi.h
ram_disk.c
ram_disk.h
usb_descriptors.c
usb_descriptors.h
usb_common.h
10