HCC USB SAF1761 Manuel utilisateur

USB SAF1761 Host Controller User Guide

USB SAF1761 Host

Controller User Guide

Version 1.20

For use with USBH SAF1761 Host Controller versions

2.11 and above

Date: 29-Aug-2017 17:54

Embedded. Reproduction or duplication by any means of any portion of this document without the

prior written consent of HCC Embedded is expressly forbidden.

HCC Embedded reserves the right to make changes to this document and to the related software at

any time and without notice. The information in this document has been carefully checked for its

accuracy; however, HCC Embedded makes no warranty relating to the correctness of this document.

USB SAF1761 Host Controller User Guide

Table of Contents

System Overview ______________________________________________________________________ 3

Introduction _________________________________________________________________________ 3

Feature Check _______________________________________________________________________ 4

Compatible Devices ___________________________________________________________________ 5

Packages and Documents ______________________________________________________________ 6

Packages ________________________________________________________________________ 6

Documents ______________________________________________________________________ 6

Change History ______________________________________________________________________ 7

Source File List ________________________________________________________________________ 8

API Header File ______________________________________________________________________ 8

Configuration File ____________________________________________________________________ 8

Source Code ________________________________________________________________________ 8

Version File _________________________________________________________________________ 8

Source Files in the Common Package ______________________________________________________ 9

Configuration File ____________________________________________________________________ 9

Source Code ________________________________________________________________________ 9

Version File _________________________________________________________________________ 9

Platform Support Package (PSP) Files ___________________________________________________ 10

Configuration Options __________________________________________________________________ 11

SAF1761 Configuration File ___________________________________________________________ 11

SAF1761/ISP1582 Common Package Configuration File _____________________________________ 11

Starting the Host Controller _____________________________________________________________ 13

usbh_isp_hc _______________________________________________________________________ 13

Host Controller Task _________________________________________________________________ 13

Code Example ______________________________________________________________________ 14

Integration ___________________________________________________________________________ 15

OS Abstraction Layer ________________________________________________________________ 15

PSP Porting ________________________________________________________________________ 16

psp_isp_init _____________________________________________________________________ 18

psp_isp_r16 _____________________________________________________________________ 19

psp_isp_r32 _____________________________________________________________________ 20

psp_isp_w16 ____________________________________________________________________ 21

psp_isp_w32 ____________________________________________________________________ 22

psp_isph_read_mem ______________________________________________________________ 23

psp_isph_read_ptd _______________________________________________________________ 24

psp_isph_write_mem _____________________________________________________________ 25

psp_isph_write_ptd _______________________________________________________________ 26

USB SAF1761 Host Controller User Guide

1 System Overview

1.1 Introduction

This guide is for those who want to implement HCC Embedded's USB host stack with NXP Semiconductors'

SAF1761 USB host controllers. The NXP devices supported are the SAF1761 and also the legacy products

ISP1760, ISP1761, and ISP1763.

The SAF1761 includes a USB host controller and a USB device controller. The USB device controller is

actually an ISP1582, for which we provide a separate driver. These two drivers can be used together as

required. This manual only covers the USB host functionality of the SAF1761. The ISP1582 is covered in

the .

USB Device Low Level Driver for ISP1582 User Guide

The SAF1761 module provides a high speed USB 2.0 host controller which provides both full and low speed

USB functions. The controller can handle all USB transfer types and, in conjunction with the USB host

stack, can be used with any USB class driver.

The position of the host controller within the USB stack is shown below:

USB SAF1761 Host Controller User Guide

1.2 Feature Check

The main features of the host controller are the following:

Conforms to the HCC Advanced Embedded Framework.

Designed for integration with both RTOS and non-RTOS based systems.

Integrated with the HCC USB Host stack and all its class drivers.

Supports NXP Semiconductors' SAF1761 host controllers and also the legacy ISP1760, ISP1761,

and ISP1763 host controllers.

Supports multiple simultaneous SAF1761 controllers, each with multiple devices attached.

Can work together with HCC's USB device controller for the ISP1582.

Supports all USB transfer types: control, bulk, interrupt, and isochronous.

USB SAF1761 Host Controller User Guide

1.3 Compatible Devices

The module supports the following devices:

Device Notes

NXP ISP1760 This is no longer marketed by NXP.

NXP ISP1761 This is no longer marketed by NXP.

ST ISP1763 This is now produced by ST Microelectronics.

NXP SAF1761 This is automotive grade, compliant with AEC-Q100.

USB SAF1761 Host Controller User Guide

1.4 Packages and Documents

Packages

The table below lists the packages that you need in order to use this module:

Package Description

hcc_base_doc This contains the two guides that will help you get started.

usbh_base The USB host base package. This is the framework used by USB class

drivers to communicate over USB using a specific USB host controller

package.

usbh_drv_isp176x The USB host controller package described by this document.

usbc_drv_isp1582_isp176x Common code used by both the SAF1761 module and the ISP1582

device low level driver module.

usbh_cd_hub The USB Host Hub class driver.

Documents

For an overview of HCC's embedded USB stacks, see on the main HCC website.Product Information

Readers should note the points in the on the HCC documentation website.HCC Documentation Guidelines

HCC Firmware Quick Start Guide

This document describes how to install packages provided by HCC in the target development environment.

Also follow the when HCC provides package updates.

Quick Start Guide

HCC Source Tree Guide

This document describes the HCC source tree. It gives an overview of the system to make clear the logic

behind its organization.

HCC USB Host Base System User Guide

This document defines the USB host base system upon which the complete USB stack is built.

HCC USB SAF1761 Host Controller User Guide

This is this document.

USB SAF1761 Host Controller User Guide

1.5 Change History

This section describes past changes to this manual.

To view or download earlier manuals, see .Archive: USB SAF1761 Host Controller User Guide

For the history of changes made to the package code itself, see andHistory: usbh_drv_isp176x

.History: usbc_drv_isp1582_isp176x

The current version of this manual is 1.20. The full list of versions is as follows:

Manual

version Date Software

version Reason for change

1.20 2017-08-29 2.11 and

1.02 Corrected list.

Packages

1.10 2017-06-19 2.11 and

1.02 New format.

Change History

1.00 2015-12-22 2.11 and

1.02 First release.

USB SAF1761 Host Controller User Guide

2 Source File List

This section describes all the source code files included in the system. These files follow the HCC

Embedded standard source tree system, described in the . All references to file

HCC Source Tree Guide

pathnames refer to locations within this standard source tree, not within the package you initially receive.

Note: Do not modify any of these files except the configuration file.

2.1 API Header File

The file is the only file that should be included by an application using thissrc/api/api_usbh_isp176x.h

module. It declares the function. For details, see .usbh_isp_hc() Starting the Host Controller

2.2 Configuration File

The file contains all the configurable parameters. Configure these assrc/config/config_usbh_isp176x.h

required. For details of these options, see .Configuration Options

2.3 Source Code

The source code files are in the directory .src/usb-host/usb-driver/isp176x These files should only be

.modified by HCC

File Description

isp176x.c Source file for SAF1761 code.

isp176x.h Header file for SAF1761 public functions.

isp176x_hc.c Source file for the SAF1761 HC descriptor.

isp176x_hc.h HC descriptor header file.

isp176x_hub.c Source file for SAF1761 hub.

isp176x_hub.h Header file for SAF1761 hub public functions.

isp176x_reg.h Header file for SAF1761 registers.

2.4 Version File

The file contains the version number of this module. This version numbersrc/version/ver_usbh_isp176x.h

is checked by all modules that use this module to ensure system consistency over upgrades.

USB SAF1761 Host Controller User Guide

3 Source Files in the Common Package

This section describes the source code files included in the common package used by both the SAF1761

module and the ISP1582 device low level driver. These files follow the HCC Embedded standard source

tree system, described in the . All references to file pathnames refer to locations

HCC Source Tree Guide

within this standard source tree, not within the package you initially receive.

Note: Do not modify any of these files except the configuration file.

3.1 Configuration File

The file contains the common configurable parameters.src/config/config_usbc_isp1582_isp176x.h

Configure these as required. For details of these options, see .Configuration Options

3.2 Source Code

The source code files are in the directory .src/usb-common/usb-drivers/isp_1582_isp176x These files

.should only be modified by HCC

File Description

usbc_isp1582_isp176x.c Source file for common code.

usbc_isp1582_isp176x.h Header file for common public functions.

3.3 Version File

The file contains the version number of this module. Thissrc/version/ver_usbh_isp1582_isp176x.h

version number is checked by all modules that use this module to ensure system consistency over

upgrades.

USB SAF1761 Host Controller User Guide

3.4 Platform Support Package (PSP) Files

These files are in the directory . They provide functions and elements thesrc/psp/target/usbh_usbd_isp

core code may need to use, depending on the hardware.

Note: These are PSP implementations for the specific microcontroller and development board; you

may need to modify these to work with a different microcontroller and/or board. See forPSP Porting

details.

File Description

psp_isp1582_isp176x.c Functions source code.

psp_isp1582_isp176x.h Functions header file.

Table des matières

Autres manuels HCC Contrôleurs

HCC

HCC USB ISP1161 Manuel utilisateur

Manuels Contrôleurs populaires d'autres marques

Digiplex

Digiplex DGP-848 Mode d'emploi

YASKAWA

YASKAWA SGM series Manuel utilisateur

Sinope

Sinope Calypso RM3500ZB Manuel utilisateur

Isimet

Isimet DLA Series Style 2 Manuel d'installation

LSIS

LSIS sv-ip5a Manuel utilisateur

Rockwell Automation

Rockwell Automation 1769-L31 Manuel utilisateur

Airflow

Airflow Uno hab Manuel utilisateur

ABB

ABB ACS580-01 drives Manuel utilisateur

Panasonic

Panasonic GM1 Series Manuel utilisateur

Emerson

Emerson SW93 Manuel utilisateur

AutoAqua

AutoAqua Smart ATO micro SATO-120P Manuel utilisateur

Panasonic

Panasonic FP? Positioning Unit RTEX Manuel utilisateur

Samson

Samson Type 5824 Manuel de service

Alpha IP

Alpha IP MIOB 21001 Manuel utilisateur

Siemens

Siemens OpenAir GMA 1 Series Manuel utilisateur

Surecom

Surecom SR-629 Manuel utilisateur

Fishman

Fishman TriplePlay Manuel utilisateur

Regulus

Regulus SRS1 T Manuel utilisateur