<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libnjb: /home/mandrake/rpm/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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnjb <span id="projectnumber">2.2.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_c382854adf3ac0f9f97376793a1b657b.html">src</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>usb_io.c File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><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/>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#a96ae11691769c1bd4bda3ea0ceaa76a5">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" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#a8c28681c955500d111dcf28ff9532b94">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" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#ab032ff44f65d3d873b2200e71ecfcf5e">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"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="usb__io_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This file contain some USB-specific code that is used by all devices. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a8c28681c955500d111dcf28ff9532b94"></a><!-- doxytag: member="usb_io.c::usb_pipe_read" ref="a8c28681c955500d111dcf28ff9532b94" 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>
</tr>
<tr>
<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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">njb</td><td>the jukebox object to use </td></tr>
<tr><td class="paramname">buf</td><td>the buffer to store the bytes in </td></tr>
<tr><td class="paramname">nbytes</td><td>the number of bytes to read in </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of bytes actually read </dd></dl>
<p>References <a class="el" href="ioutil_8c.html#a7583c2079ba212fc5d9cf4f5d331c41a">data_dump_ascii()</a>, <a class="el" href="group__debugflags.html#ga26e876ba18002aa3859687e8521644d2">DD_USBBLK</a>, <a class="el" href="group__debugflags.html#ga3bba854022c3dd4c6c091510db479dae">DD_USBBLKLIM</a>, <a class="el" href="structnjb__struct.html#a5b182e45017e20b5d918f0ac3d1b6301">njb_struct::dev</a>, <a class="el" href="base_8c.html#a53533cb709d1e889c780ebd0a1cd7989">njb_debug()</a>, and <a class="el" href="structnjb__struct.html#ae41df03fa0e8d827eb57ca610b2b6ad1">njb_struct::usb_bulk_in_ep</a>.</p>
<p>Referenced by <a class="el" href="protocol3_8h.html#a120bb9ef7afb94102b2e1f29515de0dd">njb3_add_multiple_tracks_to_playlist()</a>, <a class="el" href="protocol3_8h.html#a91831b3fc1d2c5ccafd2f62629733074">njb3_create_playlist()</a>, <a class="el" href="protocol3_8h.html#a11ff9d3e1e3a638168f290e68f6a8a20">njb3_get_codecs()</a>, <a class="el" href="protocol3_8h.html#abaa0008a62887dbbd36f6b27a8e740d8">njb3_get_file_block()</a>, <a class="el" href="protocol3_8h.html#a01ddb94dde9f1369519cea9159947291">njb3_power_status()</a>, <a class="el" href="protocol3_8h.html#a956618fea29be076067bf608190398bf">njb3_request_file_chunk()</a>, <a class="el" href="protocol_8c.html#ae959b6717b8bd6b3bcd61447e8ddda17">njb_ping()</a>, <a class="el" href="protocol_8c.html#afe8b51e10cf1a2a5d313a4c273133278">njb_read_eaxtypes()</a>, and <a class="el" href="protocol_8c.html#af1b5132b6c3f0c9f408a77cdc5e64f58">njb_receive_file_block()</a>.</p>
</div>
</div>
<a class="anchor" id="a96ae11691769c1bd4bda3ea0ceaa76a5"></a><!-- doxytag: member="usb_io.c::usb_pipe_write" ref="a96ae11691769c1bd4bda3ea0ceaa76a5" 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>
</tr>
<tr>
<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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">njb</td><td>the jukebox object to use </td></tr>
<tr><td class="paramname">buf</td><td>the buffer to send bytes from </td></tr>
<tr><td class="paramname">nbytes</td><td>the number of bytes to write </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of bytes actually written </dd></dl>
<p>References <a class="el" href="ioutil_8c.html#a7583c2079ba212fc5d9cf4f5d331c41a">data_dump_ascii()</a>, <a class="el" href="group__debugflags.html#ga26e876ba18002aa3859687e8521644d2">DD_USBBLK</a>, <a class="el" href="group__debugflags.html#ga3bba854022c3dd4c6c091510db479dae">DD_USBBLKLIM</a>, <a class="el" href="structnjb__struct.html#a5b182e45017e20b5d918f0ac3d1b6301">njb_struct::dev</a>, <a class="el" href="base_8c.html#a53533cb709d1e889c780ebd0a1cd7989">njb_debug()</a>, and <a class="el" href="structnjb__struct.html#a92169f5213824000a2e56e8528a65013">njb_struct::usb_bulk_out_ep</a>.</p>
</div>
</div>
<a class="anchor" id="ab032ff44f65d3d873b2200e71ecfcf5e"></a><!-- doxytag: member="usb_io.c::usb_setup" ref="ab032ff44f65d3d873b2200e71ecfcf5e" 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>
</tr>
<tr>
<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>
<p>References <a class="el" href="base_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a>, <a class="el" href="ioutil_8c.html#ab37e1a214ef2b2e62314d95f68e216a4">data_dump()</a>, <a class="el" href="ioutil_8c.html#a7583c2079ba212fc5d9cf4f5d331c41a">data_dump_ascii()</a>, <a class="el" href="group__debugflags.html#ga8a18137421246cc449f4da99ce3d48b4">DD_USBCTL</a>, <a class="el" href="structnjb__struct.html#a5b182e45017e20b5d918f0ac3d1b6301">njb_struct::dev</a>, and <a class="el" href="base_8c.html#a53533cb709d1e889c780ebd0a1cd7989">njb_debug()</a>.</p>
<p>Referenced by <a class="el" href="protocol_8c.html#aded817a86b7cee20247ebae531626574">njb_capture()</a>, <a class="el" href="protocol_8c.html#a1bd23c272154f003bd55075b352be5fc">njb_get_datafile_header()</a>, <a class="el" href="protocol_8c.html#a7f0a8d1560f23483fe722fb51f634fe8">njb_get_disk_usage()</a>, <a class="el" href="protocol_8c.html#ad4c55baa3faa179396f2f76ce9fbd5ca">njb_get_library_counter()</a>, <a class="el" href="protocol_8c.html#afb3d4c4e2f9fe7de9786aa47bc92da12">njb_get_playlist_header()</a>, <a class="el" href="protocol_8c.html#ab71c71bdf6131d176ad3572e72ef190b">njb_get_track_tag_header()</a>, <a class="el" href="protocol_8c.html#ae959b6717b8bd6b3bcd61447e8ddda17">njb_ping()</a>, <a class="el" href="protocol_8c.html#afe8b51e10cf1a2a5d313a4c273133278">njb_read_eaxtypes()</a>, <a class="el" href="protocol_8c.html#af1b5132b6c3f0c9f408a77cdc5e64f58">njb_receive_file_block()</a>, <a class="el" href="protocol_8c.html#a1d6bdb13a1de6c49b04a081502bcf9d4">njb_set_library_counter()</a>, and <a class="el" href="protocol_8c.html#ae5ea9fbb3859ec50540bcd9cf4a3f328">njb_verify_last_command()</a>.</p>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="usb_io.c::__sub_depth" ref="a60db410c9e82d9e61b1bf0be607922ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="usb__io_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current subroutine depth for all of libnjb (global) </p>
<p>Referenced by <a class="el" href="usb__io_8c.html#ab032ff44f65d3d873b2200e71ecfcf5e">usb_setup()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 2 2011 06:05:24 for libnjb by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
