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  * This driver exports a USB-serial converter. It provides a KFile interface
  38  * to access the data.
  39  * \attention The API is work in progress and may change in future versions.
  40  *
  41  * $WIZ$ module_name = "usbser"
  42  * $WIZ$ module_configuration = "bertos/cfg/cfg_usbser.h"
  43  * $WIZ$ module_depends = "usb"
  44  */
  45
  46 #ifndef USBSER_H
  47 #define USBSER_H
  48
  49 #include <io/kfile.h>
  50
  51 typedef uint32_t usbser_status_t;
  52
  53 typedef struct USBSerial
  54 {
  55         /** KFile structure implementation **/
  56         KFile fd;
  57         /** Logical port number */
  58         unsigned int unit;
  59 #ifdef _DEBUG
  60         /** Used for debugging only */
  61         bool is_open;
  62 #endif
  63         /** Holds the status flags. Set to 0 when no errors have occurred. */
  64         usbser_status_t status;
  65 } USBSerial;
  66
  67 /**
  68  * ID for usb-serial.
  69  */
  70 #define KFT_USB_SERIAL MAKE_ID('U', 'S', 'B', 'S')
  71
  72 INLINE USBSerial *USB_SERIAL_CAST(KFile *fd)
  73 {
  74         ASSERT(fd->_type == KFT_USB_SERIAL);
  75         return (USBSerial *)fd;
  76 }
  77
  78 int usbser_init(struct USBSerial *fds, int unit);
  79
  80 #endif /* USBSER_H */