firmware/usbstack/controller.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 by Christian Gmeiner
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19
  20 #ifndef _USBSTACK_CONTROLLER_H_
  21 #define _USBSTACK_CONTROLLER_H_
  22
  23 /*
  24  * stack datatypes
  25  */
  26 struct usb_response {
  27     void* buf;
  28     uint32_t length;
  29 };
  30
  31 struct usb_ep {
  32     const char name[15];
  33     uint8_t type;
  34     uint32_t ep_num;    /* which endpoint? */
  35     uint32_t pipe_num;  /* which pipe? */
  36     uint32_t maxpacket;
  37     bool claimed;
  38
  39     struct usb_endpoint_descriptor *desc;
  40     struct list_head list;
  41 };
  42
  43 struct usb_controller {
  44     const char* name;
  45     enum usb_controller_type type;
  46     enum usb_device_speed speed;
  47     void (*init)(void);
  48     void (*shutdown)(void);
  49     void (*irq)(void);
  50     void (*start)(void);
  51     void (*stop)(void);
  52     void* controller_ops;
  53     struct usb_device_driver* device_driver;
  54     struct usb_host_driver* host_driver;
  55     struct usb_ep* ep0;
  56     struct usb_ep endpoints;
  57 };
  58
  59 struct usb_dcd_controller_ops {
  60     /* endpoint management */
  61     int (*enable)(struct usb_ep* ep, struct usb_endpoint_descriptor* desc);
  62     int (*disable)(struct usb_ep* ep);
  63     int (*set_halt)(struct usb_ep* ep, bool hald);
  64
  65     /* transmitting */
  66     int (*send)(struct usb_ep* ep, struct usb_response* req);
  67     int (*receive)(struct usb_ep* ep, struct usb_response* res);
  68
  69     /* ep0 */
  70     struct usb_ep* ep0;
  71 };
  72
  73 int usb_controller_register(struct usb_controller* ctrl);
  74 int usb_controller_unregister(struct usb_controller* ctrl);
  75
  76 /*
  77  * dcd - device controller driver
  78  */
  79 void usb_dcd_init(void);
  80 void usb_dcd_shutdown(void);
  81
  82 /*
  83  * hcd - host controller driver
  84  */
  85 void usb_hcd_init(void);
  86 void usb_hcd_shutdown(void);
  87
  88 #endif /*_USBSTACK_CONTROLLER_H_*/