bertos/drv/usbser.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Andrea Righi <arighi@develer.com>
  34  *
  35  * \brief Generic USB serial device driver.
  36  *
  37  * $WIZ$ module_name = "usbser"
  38  * $WIZ$ module_configuration = "bertos/cfg/cfg_usbser.h"
  39  * $WIZ$ module_depends = "usb"
  40  */
  41
  42 #ifndef USBSER_H
  43 #define USBSER_H
  44
  45 #include <io/kfile.h>
  46
  47 typedef uint32_t usbser_status_t;
  48
  49 typedef struct USBSerial
  50 {
  51         /** KFile structure implementation **/
  52         KFile fd;
  53         /** Logical port number */
  54         unsigned int unit;
  55 #ifdef _DEBUG
  56         /** Used for debugging only */
  57         bool is_open;
  58 #endif
  59         /** Holds the status flags. Set to 0 when no errors have occurred. */
  60         usbser_status_t status;
  61 } USBSerial;
  62
  63 /**
  64  * ID for usb-serial.
  65  */
  66 #define KFT_USB_SERIAL MAKE_ID('U', 'S', 'B', 'S')
  67
  68 INLINE USBSerial *USB_SERIAL_CAST(KFile *fd)
  69 {
  70         ASSERT(fd->_type == KFT_USB_SERIAL);
  71         return (USBSerial *)fd;
  72 }
  73
  74 int usbser_init(struct USBSerial *fds, int unit);
  75
  76 #endif /* USBSER_H */