<!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/base.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>base.c File Reference</h1><code>#include "<a class="el" href="libnjb_8h_source.html">libnjb.h</a>"</code><br>
<code>#include "njb_error.h"</code><br>
<code>#include "defs.h"</code><br>
<code>#include "base.h"</code><br>
<code>#include "protocol.h"</code><br>
<code>#include "<a class="el" href="protocol3_8h_source.html">protocol3.h</a>"</code><br>
<code>#include "usb_io.h"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>njb_device_entry</b></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a99741dc645a280ac45a9f2d576c4506"></a><!-- doxytag: member="base.c::njb_device_entry_t" ref="a99741dc645a280ac45a9f2d576c4506" args="" -->
typedef struct njb_device_entry </td><td class="memItemRight" valign="bottom"><b>njb_device_entry_t</b></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#a4e733ca216b5018fc0be303a080d0f2">njb_discover</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njbs, int limit, int *count)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#e7a3017562ff53c08d528260511e0456">njb_close</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#ac86db6853a2e7b6345bf9544ff830a3">njb_open</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#cfa06caf868fa5b7c9f73f3bc26594e2">njb_set_debug</a> (int flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#53533cb709d1e889c780ebd0a1cd7989">njb_debug</a> (int flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#8204c8f74fd8a8e5069f4239f3b10e0a">njb_get_usb_device_name</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#289d8808f6945391ab9692724a59b577">njb_device_is_usb20</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">njb_protocol_type_t </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#42bdc45073c88817f01aa94c3092b2db">njb_get_device_protocol</a> (<a class="el" href="structnjb__struct.html">njb_t</a> *njb)</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="base_8c.html#f76292e64f93304921849d38c5888f01">njb_debug_flags</a> = 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base_8c.html#60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a> = 0</td></tr>
</table>
<hr><h2>Detailed Description</h2>
This file contains the basic stuff for opening the device on the USB bus and similar things. Here are the jukebox detection algorithms for example. <hr><h2>Function Documentation</h2>
<a class="anchor" name="e7a3017562ff53c08d528260511e0456"></a><!-- doxytag: member="base.c::njb_close" ref="e7a3017562ff53c08d528260511e0456" args="(njb_t *njb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void njb_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close a specific njb for reading and writing.<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 close </td></tr>
</table>
</dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, <a class="el" href="libnjb_8h_source.html#l00189">njb_struct::device_type</a>, <a class="el" href="libnjb_8h_source.html#l00072">NJB_DEVICE_NJB1</a>, <a class="el" href="libnjb_8h_source.html#l00188">njb_struct::usb_bulk_out_ep</a>, and <a class="el" href="libnjb_8h_source.html#l00186">njb_struct::usb_interface</a>.</p>
<p>Referenced by <a class="el" href="procedure_8c_source.html#l00184">NJB_Close()</a>.</p>
</div>
</div><p>
<a class="anchor" name="53533cb709d1e889c780ebd0a1cd7989"></a><!-- doxytag: member="base.c::njb_debug" ref="53533cb709d1e889c780ebd0a1cd7989" args="(int flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int njb_debug </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the current debug flags<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>flags</em> </td><td>a binary mask that remove some of the flags. </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="usb__io_8c_source.html#l00076">usb_pipe_read()</a>, <a class="el" href="usb__io_8c_source.html#l00027">usb_pipe_write()</a>, and <a class="el" href="usb__io_8c_source.html#l00123">usb_setup()</a>.</p>
</div>
</div><p>
<a class="anchor" name="289d8808f6945391ab9692724a59b577"></a><!-- doxytag: member="base.c::njb_device_is_usb20" ref="289d8808f6945391ab9692724a59b577" args="(njb_t *njb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int njb_device_is_usb20 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell if a device is USB 2.0 or not <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the device is USB 2.0, 0 if it is USB 1.1 </dd></dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00189">njb_struct::device_type</a>.</p>
</div>
</div><p>
<a class="anchor" name="a4e733ca216b5018fc0be303a080d0f2"></a><!-- doxytag: member="base.c::njb_discover" ref="a4e733ca216b5018fc0be303a080d0f2" args="(njb_t *njbs, int limit, int *count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int njb_discover </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njbs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search the USB bus for a Nomad JukeBox. We can handle up to NJB_MAX_DEVICES JukeBox's per USB simultaneously (a value arbitrarily set in <a class="el" href="base_8h_source.html">base.h</a>, because it's easier to work with a fixed size array than build dynamically growing code...if anyone _really_ plans on having more than NJB_MAX_DEVICES jukeboxes on their system, they can recompile with a bigger number). The USB device starts at usb0 and goes to usbNNN where NNN is USB_MAX_DEVICES. Check each bus for a usb device. Return -1 if errors occurred...though this doesn't mean we failed to find devices. *count gives the number of NJB devices that were found. Store the resulting NJB structues structure into the njbs[NJB_MAX_DEVICES] array.<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>njbs</em> </td><td>an array of jukeboxes to fill up. The array must be NJB_MAX_DEVICES large. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>limit</em> </td><td>a variable that is supposed to limit the number of devices retrieved, currently not used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>a pointer to a variable that will hold the number of devices found after the call to this function. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on OK, -1 on failure. </dd></dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, <a class="el" href="libnjb_8h_source.html#l00183">njb_struct::device</a>, and <a class="el" href="libnjb_8h_source.html#l00189">njb_struct::device_type</a>.</p>
<p>Referenced by <a class="el" href="procedure_8c_source.html#l00108">NJB_Discover()</a>.</p>
</div>
</div><p>
<a class="anchor" name="42bdc45073c88817f01aa94c3092b2db"></a><!-- doxytag: member="base.c::njb_get_device_protocol" ref="42bdc45073c88817f01aa94c3092b2db" args="(njb_t *njb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">njb_protocol_type_t njb_get_device_protocol </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell which protocol version a device is using.
<p>References <a class="el" href="libnjb_8h_source.html#l00189">njb_struct::device_type</a>.</p>
</div>
</div><p>
<a class="anchor" name="8204c8f74fd8a8e5069f4239f3b10e0a"></a><!-- doxytag: member="base.c::njb_get_usb_device_name" ref="8204c8f74fd8a8e5069f4239f3b10e0a" args="(njb_t *njb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* njb_get_usb_device_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a device name from its USB characteristics.
<p>References <a class="el" href="libnjb_8h_source.html#l00189">njb_struct::device_type</a>.</p>
<p>Referenced by <a class="el" href="procedure_8c_source.html#l03456">NJB_Get_Device_Name()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ac86db6853a2e7b6345bf9544ff830a3"></a><!-- doxytag: member="base.c::njb_open" ref="ac86db6853a2e7b6345bf9544ff830a3" args="(njb_t *njb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int njb_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__struct.html">njb_t</a> * </td>
<td class="paramname"> <em>njb</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open a specific njb for reading and writing.<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 open </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure </dd></dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00184">njb_struct::dev</a>, <a class="el" href="libnjb_8h_source.html#l00183">njb_struct::device</a>, <a class="el" href="libnjb_8h_source.html#l00185">njb_struct::usb_config</a>, and <a class="el" href="libnjb_8h_source.html#l00186">njb_struct::usb_interface</a>.</p>
<p>Referenced by <a class="el" href="procedure_8c_source.html#l00130">NJB_Open()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cfa06caf868fa5b7c9f73f3bc26594e2"></a><!-- doxytag: member="base.c::njb_set_debug" ref="cfa06caf868fa5b7c9f73f3bc26594e2" args="(int flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void njb_set_debug </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the debug flags to use.<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>flags</em> </td><td>the flags to set </td></tr>
</table>
</dl>
<p>Referenced by <a class="el" href="procedure_8c_source.html#l02819">NJB_Set_Debug()</a>.</p>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="base.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> = 0 </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>
<a class="anchor" name="f76292e64f93304921849d38c5888f01"></a><!-- doxytag: member="base.c::njb_debug_flags" ref="f76292e64f93304921849d38c5888f01" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="base_8c.html#f76292e64f93304921849d38c5888f01">njb_debug_flags</a> = 0 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The current debug flags for all if libnjb (global)
</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>
