usbs-devtab.html
来自「ecos3.0 beta 的官方文档,html格式」· HTML 代码 · 共 491 行
HTML
491 行
<!-- Copyright (C) 2009 Free Software Foundation, Inc. -->
<!-- This material may be distributed only subject to the terms -->
<!-- and conditions set forth in the Open Publication License, v1.0 -->
<!-- or later (the latest version is presently available at -->
<!-- http://www.opencontent.org/openpub/). -->
<!-- Distribution of the work or derivative of the work in any -->
<!-- standard (paper) book form is prohibited unless prior -->
<!-- permission is obtained from the copyright holder. -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Devtab Entries</TITLE
><meta name="MSSmartTagsPreventParsing" content="TRUE">
<META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="eCos Reference Manual"
HREF="ecos-ref.html"><LINK
REL="UP"
TITLE="eCos USB Slave Support"
HREF="io-usb-slave.html"><LINK
REL="PREVIOUS"
TITLE="Starting up a USB Device"
HREF="usbs-start.html"><LINK
REL="NEXT"
TITLE="Receiving Data from the Host"
HREF="usbs-start-rx.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>eCos Reference Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="usbs-start.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="usbs-start-rx.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="USBS-DEVTAB"
></A
>Devtab Entries</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN16136"
></A
><H2
>Name</H2
>Devtab Entries -- Data endpoint data structure</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN16139"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>/dev/usb0c
/dev/usb1r
/dev/usb2w</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN16141"
></A
><H2
>Devtab Entries</H2
><P
>USB device drivers provide two ways of transferring data between host
and peripheral. The first involves USB-specific functionality such as
<A
HREF="usbs-start-rx.html"
><CODE
CLASS="FUNCTION"
>usbs_start_rx_buffer</CODE
></A
>.
This provides non-blocking I/O: a transfer is started, and some time
later the device driver will call a supplied completion function. The
second uses the conventional I/O model: there are entries in the
device table corresponding to the various endpoints. Standard calls
such as <CODE
CLASS="FUNCTION"
>open</CODE
> can then be used to get a suitable
handle. Actual I/O happens via blocking <CODE
CLASS="FUNCTION"
>read</CODE
> and
<CODE
CLASS="FUNCTION"
>write</CODE
> calls. In practice the blocking operations
are simply implemented using the underlying non-blocking
functionality.</P
><P
>Each endpoint will have its own devtab entry. The exact names are
controlled by the device driver package, but typically the root will
be <TT
CLASS="LITERAL"
>/dev/usb</TT
>. This is followed by one or more
decimal digits giving the endpoint number, followed by
<TT
CLASS="LITERAL"
>c</TT
> for a control endpoint, <TT
CLASS="LITERAL"
>r</TT
> for
a receive endpoint (host to peripheral), and <TT
CLASS="LITERAL"
>w</TT
> for
a transmit endpoint (peripheral to host). If the target hardware
involves more than one USB device then different roots should be used,
for example <TT
CLASS="LITERAL"
>/dev/usb0c</TT
> and
<TT
CLASS="LITERAL"
>/dev/usb1_0c</TT
>. This may require explicit
manipulation of device driver configuration options by the application
developer.</P
><P
>At present the devtab entry for a control endpoint does not support
any I/O operations. </P
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16157"
></A
><H3
><CODE
CLASS="FUNCTION"
>write</CODE
> operations</H3
><P
><CODE
CLASS="FUNCTION"
>cyg_io_write</CODE
> and similar functions in
higher-level packages can be used to perform a transfer from
peripheral to host. Successive write operations will not be coalesced.
For example, when doing a 1000 byte write to an endpoint that uses the
bulk transfer protocol this will involve 15 full-size 64-byte packets
and a terminating 40-byte packet. USB device drivers are not expected
to do any locking, and if higher-level code performs multiple
concurrent write operations on a single endpoint then the resulting
behaviour is undefined.</P
><P
>A USB <CODE
CLASS="FUNCTION"
>write</CODE
> operation will never transfer less
data than specified. It is the responsibility of higher-level code to
ensure that the amount of data being transferred is acceptable to the
host-side code. Usually this will be defined by a higher-level
protocol. If an attempt is made to transfer more data than the host
expects then the resulting behaviour is undefined.</P
><P
>There are two likely error conditions. <TT
CLASS="LITERAL"
>EPIPE</TT
>
indicates that the connection between host and target has been broken.
<TT
CLASS="LITERAL"
>EAGAIN</TT
> indicates that the endpoint has been
stalled, either at the request of the host or by other activity
inside the peripheral.</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16167"
></A
><H3
><CODE
CLASS="FUNCTION"
>read</CODE
> operations</H3
><P
><CODE
CLASS="FUNCTION"
>cyg_io_read</CODE
> and similar functions in higher-level
packages can be used to perform a transfer from host to peripheral.
This should be a complete transfer: higher-level protocols should
define an upper bound on the amount of data being transferred, and the
<CODE
CLASS="FUNCTION"
>read</CODE
> operation should involve at least this
amount of data. The return value will indicate the actual transfer
size, which may be less than requested.</P
><P
>Some device drivers may support partial reads, but USB device drivers
are not expected to perform any buffering because that involves both
memory and code overheads. One technique that may work for bulk
transfers is to exploit the fact that such transfers happen in 64-byte
packets. It is possible to <CODE
CLASS="FUNCTION"
>read</CODE
> an initial 64
bytes, corresponding to the first packet in the transfer. These 64
bytes can then be examined to determine the total transfer size, and
the remaining data can be transferred in another
<CODE
CLASS="FUNCTION"
>read</CODE
> operation. This technique is not guaranteed
to work with all USB hardware. Also, if the delay between accepting
the first packet and the remainder of the transfer is excessive then
this could cause timeout problems for the host-side software. For
these reasons the use of partial reads should be avoided.</P
><P
>There are two likely error conditions. <TT
CLASS="LITERAL"
>EPIPE</TT
>
indicates that the connection between host and target has been broken.
<TT
CLASS="LITERAL"
>EAGAIN</TT
> indicates that the endpoint has been
stalled, either at the request of the host or by other activity
inside the peripheral.</P
><P
>USB device drivers are not expected to do any locking. If higher-level
code performs multiple concurrent read operations on a single endpoint
then the resulting behaviour is undefined.</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16180"
></A
><H3
><CODE
CLASS="FUNCTION"
>select</CODE
> operations</H3
><P
>Typical USB device drivers will not provide any support for
<CODE
CLASS="FUNCTION"
>select</CODE
>. Consider bulk transfers from the host to
the peripheral. At the USB device driver level there is no way of
knowing in advance how large a transfer will be, so it is not feasible
for the device driver to buffer the entire transfer. It may be
possible to buffer part of the transfer, for example the first 64-byte
packet, and copy this into application space at the start of a
<CODE
CLASS="FUNCTION"
>read</CODE
>, but this adds code and memory overheads.
Worse, it means that there is an unknown but potentially long delay
between a peripheral accepting the first packet of a transfer and the
remaining packets, which could confuse or upset the host-side
software.</P
><P
>With some USB hardware it may be possible for the device driver to
detect OUT tokens from the host without actually accepting the data,
and this would indicate that a <CODE
CLASS="FUNCTION"
>read</CODE
> is likely to
succeed. However, it would not be reliable since the host-side I/O
operation could time out. A similar mechanism could be used to
implement <CODE
CLASS="FUNCTION"
>select</CODE
> for outgoing data, but again
this would not be reliable.</P
><P
>Some device drivers may provide partial support for
<CODE
CLASS="FUNCTION"
>select</CODE
> anyway, possibly under the control of a
configuration option. The device driver's documentation should be
consulted for further information. It is also worth noting that the
USB-specific non-blocking API can often be used as an alternative to
<CODE
CLASS="FUNCTION"
>select</CODE
>.</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16192"
></A
><H3
><CODE
CLASS="FUNCTION"
>get_config</CODE
> and
<CODE
CLASS="FUNCTION"
>set_config</CODE
> operations</H3
><P
>There are no <CODE
CLASS="FUNCTION"
>set_config</CODE
> or
<CODE
CLASS="FUNCTION"
>get_config</CODE
> (also known as
<CODE
CLASS="FUNCTION"
>ioctl</CODE
>) operations defined for USB devices.
Some device drivers may provide hardware-specific facilities this way. </P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Currently the USB-specific functions related to <A
HREF="usbs-halt.html"
>halted endpoints</A
> cannot be accessed readily
via devtab entries. This functionality should probably be made
available via <CODE
CLASS="FUNCTION"
>set_config</CODE
> and
<CODE
CLASS="FUNCTION"
>get_config</CODE
>. It may also prove useful to provide
a <CODE
CLASS="FUNCTION"
>get_config</CODE
> operation that maps from the
devtab entries to the underlying endpoint data structures.</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16206"
></A
><H3
>Presence</H3
><P
>The devtab entries are optional. If the USB device is accessed
primarily by class-specific code such as the USB-ethernet package and
that package uses the USB-specific API directly, the devtab entries
are redundant. Even if application code does need to access the USB
device, the non-blocking API may be more convenient than the blocking
I/O provided via the devtab entries. In these cases the devtab entries
serve no useful purpose, but they still impose a memory overhead. It
is possible to suppress the presence of these entries by disabling the
configuration option
<TT
CLASS="LITERAL"
>CYGGLO_IO_USB_SLAVE_PROVIDE_DEVTAB_ENTRIES</TT
>.</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="usbs-start.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ecos-ref.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="usbs-start-rx.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Starting up a USB Device</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="io-usb-slave.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Receiving Data from the Host</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?