<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv=Content-Type content="text/html; charset=utf8">
<title>/usr/web/sources/contrib/nemo/u.h - Plan 9 from Bell Labs</title>
<!-- THIS FILE IS AUTOMATICALLY GENERATED. -->
<!-- EDIT sources.tr INSTEAD. -->
</meta>
</head>
<body>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<p style="line-height: 1.2em; margin-left: 1.00in; text-indent: 0.00in; margin-right: 1.00in; margin-top: 0; margin-bottom: 0; text-align: center;">
<span style="font-size: 10pt"><a href="/plan9/">Plan 9 from Bell Labs</a>&rsquo;s /usr/web/sources/contrib/nemo/u.h</span></p>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<center><font size=-1>
Copyright © 2009 Alcatel-Lucent.<br />
Distributed under the
<a href="/plan9/license.html">Lucent Public License version 1.02</a>.
<br />
<a href="/plan9/download.html">Download the Plan 9 distribution.</a>
</font>
</center>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<table width="100%" cellspacing=0 border=0><tr><td align="center">
<table cellspacing=0 cellpadding=5 bgcolor="#eeeeff"><tr><td align="left">
<pre>
<!-- END HEADER -->
/*
* common USB definitions
*/
typedef struct Ctlr Ctlr;
typedef struct Endpt Endpt;
typedef struct Udev Udev;
typedef struct Usbhost Usbhost;

enum
{
       MaxUsb = 10,    /* max # of USB Host Controller Interfaces (Usbhost*) */
       MaxUsbDev = 32, /* max # of attached USB devs, including root hub (Udev*) */

       /* request type */
       RH2D = 0&lt;&lt;7,              /* output */
       RD2H = 1&lt;&lt;7,              /* input */
       Rstandard = 0&lt;&lt;5,
       Rclass  = 1&lt;&lt;5,
       Rvendor = 2&lt;&lt;5,

       Rdevice = 0,
       Rinterface = 1,
       Rendpt = 2,
       Rother = 3,
};

#define Class(csp)      ((csp)&amp;0xff)
#define Subclass(csp)   (((csp)&gt;&gt;8)&amp;0xff)
#define Proto(csp)      (((csp)&gt;&gt;16)&amp;0xff)
#define CSP(c, s, p)    ((c) | ((s)&lt;&lt;8) | ((p)&lt;&lt;16))

/* for OHCI */
typedef struct ED ED;
struct ED {
       ulong   ctrl;
       ulong   tail;           /* transfer descriptor */
       ulong   head;
       ulong   next;
};

enum{
       Dirout,
       Dirin,
};

/*
* device endpoint
*/
struct Endpt
{
       Ref;
       Lock;
       int     x;              /* index in Udev.ep */
       struct{         /* OHCI */
               char*   err;    /* needs to be global for unstall; fix? */
               int     xdone;
               int     xstarted;
               int     queued; /* # of TDs queued on ED */
               Rendez  rend;
       }       dir[2];
       int     epmode;
       int     epnewmode;
       int     id;             /* hardware endpoint address */
       int     maxpkt;         /* maximum packet size (from endpoint descriptor) */
       uchar   wdata01;        /* 0=DATA0, 1=DATA1 for output direction */
       uchar   rdata01;        /* 0=DATA0, 1=DATA1 for input direction */
       int     override;       /* a data command sets this and prevents
                                * auto setting of rdata01 or wdata01
                                */
       uchar   eof;
       ulong   csp;
       uchar   mode;           /* OREAD, OWRITE, ORDWR */
       uchar   nbuf;           /* number of buffers allowed */
       uchar   debug;
       uchar   active;         /* listed for examination by interrupts */
       int     setin;
       /* ISO is all half duplex, so need only one copy of these: */
       ulong   bw;             /* bandwidth requirement (OHCI) */
       int     hz;
       int     remain;         /* for packet size calculations */
       int     partial;        /* last iso packet may have been half full */
       Block   *bpartial;
       int     samplesz;
       int     sched;          /* schedule index; -1 if undefined or aperiodic */
       int     pollms;         /* polling interval in msec */
       int     psize;          /* (remaining) size of this packet */
       int     off;            /* offset into packet */
       /* Real-time iso stuff */
       vlong   foffset;        /* file offset (to detect seeks) */
       ulong   poffset;        /* offset of next packet to be queued */
       short   frnum;          /* frame number associated with poffset */
       int     rem;            /* remainder after rounding Hz to samples/ms */
       vlong   toffset;        /* offset associated with time */
       vlong   time;           /* time associated with offset */
       int     buffered;       /* bytes captured but unread, or written but unsent */
       /* end ISO stuff */

       Udev*   dev;            /* owning device */

       ulong   nbytes;
       ulong   nblocks;

       void    *private;

       /*
        * all the rest could (should?) move to the driver private structure;
        * except perhaps err.
        */
       QLock   rlock;
       Queue*  rq;

       QLock   wlock;
       Queue*  wq;

       int     ntd;

       Endpt*  activef;        /* active endpoint list */
};

/* OHCI endpoint modes */
enum {
       Nomode,
       Ctlmode,
       Bulkmode,
       Intrmode,
       Isomode,
       Nmodes,
};

/* device parameters */
enum
{
       /* Udev.state */
       Disabled = 0,
       Attached,
       Enabled,
       Assigned,
       Configured,

       /* Udev.class */
       Noclass = 0,
       Hubclass = 9,
};

typedef enum {
       Fullspeed,      /* Don't change order, used in ehci h/w interface */
       Lowspeed,
       Highspeed,
       Nospeed,
} Speed;        /* Device speed */

/*
* active USB device
*/
struct Udev
{
       Ref;
       Lock;
       Usbhost *uh;
       int     x;              /* index in usbdev[] */
       int     busy;
       int     state;
       int     id;
       uchar   port;           /* port number on connecting hub */
       ulong   csp;
       ushort  vid;            /* vendor id */
       ushort  did;            /* product id */
       Speed   speed;
       int     npt;
       Endpt*  ep[16];         /* active end points */
       Udev*   ports;          /* active ports, if hub */
       Udev*   next;           /* next device on this hub */
};

/*
* port status bits (ohci/uhci)
* usbd depends on these.
*/
enum
{
       Suspend =       1&lt;&lt;12,
       PortReset =     1&lt;&lt;9,
       SlowDevice =    1&lt;&lt;8,
       ResumeDetect =  1&lt;&lt;6,
       PortChange =    1&lt;&lt;3,     /* write 1 to clear */
       PortEnable =    1&lt;&lt;2,
       StatusChange =  1&lt;&lt;1,     /* write 1 to clear */
       DevicePresent = 1&lt;&lt;0,

};

/*
* One of these per active Host Controller Interface (HCI)
*/
struct Usbhost
{
       ISAConf;                /* hardware info */
       int     tbdf;           /* type+busno+devno+funcno */

       QLock;                  /* protects namespace state */
       int     idgen;          /* version # to distinguish new connections */
       Udev*   dev[MaxUsbDev]; /* device endpoints managed by this HCI */
       int     portsts;                /* port with status request issued */

       void    (*init)(Usbhost*);
       void    (*interrupt)(Ureg*, void*);

       void    (*debug)(Usbhost*, char*, char*);
       int     (*portstatus)(Usbhost*, int);
       void    (*portreset)(Usbhost*, int);
       void    (*portenable)(Usbhost*, int, int);

       void    (*epalloc)(Usbhost*, Endpt*);
       void    (*epfree)(Usbhost*, Endpt*);
       void    (*epopen)(Usbhost*, Endpt*);
       void    (*epclose)(Usbhost*, Endpt*);
       void    (*epmode)(Usbhost*, Endpt*);
       void    (*epmaxpkt)(Usbhost*, Endpt*);

       long    (*read)(Usbhost*, Endpt*, void*, long, vlong);
       long    (*write)(Usbhost*, Endpt*, void*, long, vlong, int);

       void    *ctlr;

       int     tokin;
       int     tokout;
       int     toksetup;
};

extern void addusbtype(char*, int(*)(Usbhost*));
<!-- BEGIN TAIL -->
</pre>
</td></tr></table>
</td></tr></table>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<p style="line-height: 1.2em; margin-left: 1.00in; text-indent: 0.00in; margin-right: 1.00in; margin-top: 0; margin-bottom: 0; text-align: center;">
<span style="font-size: 10pt"></span></p>
<p style="margin-top: 0; margin-bottom: 0.50in"></p>
<p style="margin-top: 0; margin-bottom: 0.33in"></p>
<center><table border="0"><tr>
<td valign="middle"><a href="http://www.alcatel-lucent.com/"><img border="0" src="/plan9/img/logo_ft.gif" alt="Bell Labs" />
</a></td>
<td valign="middle"><a href="http://www.opensource.org"><img border="0" alt="OSI certified" src="/plan9/img/osi-certified-60x50.gif" />
</a></td>
<td><img style="padding-right: 45px;" alt="Powered by Plan 9" src="/plan9/img/power36.gif" />
</td>
</tr></table></center>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<center>
<span style="font-size: 10pt">(<a href="/plan9/">Return to Plan 9 Home Page</a>)</span>
</center>
<p style="margin-top: 0; margin-bottom: 0.17in"></p>
<center><font size=-1>
<span style="font-size: 10pt"><a href="http://www.lucent.com/copyright.html">Copyright</a></span>
<span style="font-size: 10pt">© 2009 Alcatel-Lucent.</span>
<span style="font-size: 10pt">All Rights Reserved.</span>
<br />
<span style="font-size: 10pt">Comments to</span>
<span style="font-size: 10pt"><a href="mailto:[email protected]">[email protected]</a>.</span>
</font></center>
</body>
</html>