<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libnjb: /builddir/build/BUILD/libnjb-2.2.6/src/usb_io.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_a231d544ee85f784af5e92462fb4d8ea.html">src</a>
</div>
</div>
<div class="contents">
<h1>usb_io.c File Reference</h1><code>#include <string.h></code><br>
<code>#include <usb.h></code><br>
<code>#include "base.h"</code><br>
<code>#include "<a class="el" href="libnjb_8h_source.html">libnjb.h</a>"</code><br>
<code>#include "ioutil.h"</code><br>
<code>#include "usb_io.h"</code><br>
<code>#include "njb_error.h"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#96ae11691769c1bd4bda3ea0ceaa76a5">usb_pipe_write</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb, void *buf, size_t nbytes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#8c28681c955500d111dcf28ff9532b94">usb_pipe_read</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb, void *buf, size_t nbytes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#b032ff44f65d3d873b2200e71ecfcf5e">usb_setup</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb, int type, int request, int value, int index, int length, void *data)</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
</table>
<hr><h2>Detailed Description</h2>
This file contain some USB-specific code that is used by all devices. <hr><h2>Function Documentation</h2>
<a class="anchor" name="8c28681c955500d111dcf28ff9532b94"></a><!-- doxytag: member="usb_io.c::usb_pipe_read" ref="8c28681c955500d111dcf28ff9532b94" args="(njb_t *njb, void *buf, size_t nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t usb_pipe_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nbytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function reads a chunk of bytes to a buffer from a device's IN endpoint.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>njb</em> </td><td>the jukebox object to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>the buffer to store the bytes in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbytes</em> </td><td>the number of bytes to read in </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes actually read </dd></dl>
<p>References <a class="el" href="ioutil_8c_source.html#l00060">data_dump_ascii()</a>, <a class="el" href="libnjb_8h_source.html#l00137">DD_USBBLK</a>, <a class="el" href="libnjb_8h_source.html#l00136">DD_USBBLKLIM</a>, <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, <a class="el" href="base_8c_source.html#l00361">njb_debug()</a>, and <a class="el" href="libnjb_8h_source.html#l00187">njb_struct::usb_bulk_in_ep</a>.</p>
<p>Referenced by <a class="el" href="protocol3_8c_source.html#l03827">njb3_add_multiple_tracks_to_playlist()</a>, <a class="el" href="protocol3_8c_source.html#l03749">njb3_create_playlist()</a>, <a class="el" href="protocol3_8c_source.html#l00222">njb3_get_codecs()</a>, <a class="el" href="protocol3_8c_source.html#l03231">njb3_get_file_block()</a>, <a class="el" href="protocol3_8c_source.html#l00399">njb3_power_status()</a>, <a class="el" href="protocol3_8c_source.html#l03127">njb3_request_file_chunk()</a>, <a class="el" href="protocol_8c_source.html#l00285">njb_ping()</a>, <a class="el" href="protocol_8c_source.html#l01197">njb_read_eaxtypes()</a>, and <a class="el" href="protocol_8c_source.html#l00812">njb_receive_file_block()</a>.</p>
</div>
</div><p>
<a class="anchor" name="96ae11691769c1bd4bda3ea0ceaa76a5"></a><!-- doxytag: member="usb_io.c::usb_pipe_write" ref="96ae11691769c1bd4bda3ea0ceaa76a5" args="(njb_t *njb, void *buf, size_t nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t usb_pipe_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nbytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function writes a number of bytes from a buffer to a devices OUT endpoint.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>njb</em> </td><td>the jukebox object to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>the buffer to send bytes from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbytes</em> </td><td>the number of bytes to write </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes actually written </dd></dl>
<p>References <a class="el" href="ioutil_8c_source.html#l00060">data_dump_ascii()</a>, <a class="el" href="libnjb_8h_source.html#l00137">DD_USBBLK</a>, <a class="el" href="libnjb_8h_source.html#l00136">DD_USBBLKLIM</a>, <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, <a class="el" href="base_8c_source.html#l00361">njb_debug()</a>, and <a class="el" href="libnjb_8h_source.html#l00188">njb_struct::usb_bulk_out_ep</a>.</p>
</div>
</div><p>
<a class="anchor" name="b032ff44f65d3d873b2200e71ecfcf5e"></a><!-- doxytag: member="usb_io.c::usb_setup" ref="b032ff44f65d3d873b2200e71ecfcf5e" args="(njb_t *njb, int type, int request, int value, int index, int length, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usb_setup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function sends a USB SETUP 8-byte command across to endpoint 0 on the device.
<p>References <a class="el" href="base_8c_source.html#l00062">__sub_depth</a>, <a class="el" href="ioutil_8c_source.html#l00035">data_dump()</a>, <a class="el" href="ioutil_8c_source.html#l00060">data_dump_ascii()</a>, <a class="el" href="libnjb_8h_source.html#l00135">DD_USBCTL</a>, <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, and <a class="el" href="base_8c_source.html#l00361">njb_debug()</a>.</p>
<p>Referenced by <a class="el" href="protocol_8c_source.html#l00372">njb_capture()</a>, <a class="el" href="protocol_8c_source.html#l00708">njb_get_datafile_header()</a>, <a class="el" href="protocol_8c_source.html#l00596">njb_get_disk_usage()</a>, <a class="el" href="protocol_8c_source.html#l00241">njb_get_library_counter()</a>, <a class="el" href="protocol_8c_source.html#l00498">njb_get_playlist_header()</a>, <a class="el" href="protocol_8c_source.html#l00406">njb_get_track_tag_header()</a>, <a class="el" href="protocol_8c_source.html#l00285">njb_ping()</a>, <a class="el" href="protocol_8c_source.html#l01197">njb_read_eaxtypes()</a>, <a class="el" href="protocol_8c_source.html#l00812">njb_receive_file_block()</a>, <a class="el" href="protocol_8c_source.html#l00207">njb_set_library_counter()</a>, and <a class="el" href="protocol_8c_source.html#l00341">njb_verify_last_command()</a>.</p>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="usb_io.c::__sub_depth" ref="60db410c9e82d9e61b1bf0be607922ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="usb__io_8c.html#60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The current subroutine depth for all of libnjb (global)
<p>Referenced by <a class="el" href="usb__io_8c_source.html#l00123">usb_setup()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 17:17:29 2009 for libnjb by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
