bertos/drv/ser.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 2003,2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief High level serial I/O API.
  35  *
  36  * \version $Id$
  37  * \author Bernie Innocenti <bernie@codewiz.org>
  38  *
  39  * $WIZ$ module_name = "ser"
  40  * $WIZ$ module_depends = "kfile", "timer"
  41  * $WIZ$ module_configuration = "bertos/cfg/cfg_ser.h"
  42  * $WIZ$ module_hw = "bertos/hw/hw_ser.h"
  43  * $WIZ$ module_supports =  "not atmega103 and not atmega32 and not atmega8"
  44  */
  45
  46 #ifndef DRV_SER_H
  47 #define DRV_SER_H
  48
  49 #include <io/kfile.h>
  50 #include <struct/fifobuf.h>
  51 #include <cfg/compiler.h>
  52
  53 #if OS_HOSTED
  54         #include <cfg/macros.h> /* BV() */
  55
  56         typedef uint16_t serstatus_t;
  57
  58         /* Software errors */
  59         #define SERRF_RXFIFOOVERRUN  BV(0)  /**< Rx FIFO buffer overrun */
  60         #define SERRF_RXTIMEOUT      BV(1)  /**< Receive timeout */
  61         #define SERRF_TXTIMEOUT      BV(2)  /**< Transmit timeout */
  62
  63         /* Hardware errors */
  64         #define SERRF_RXSROVERRUN    0      /**< Rx shift register overrun, unsupported in emulated serial port. */
  65         #define SERRF_FRAMEERROR     0      /**< Stop bit missing, unsupported in emulated serial port. */
  66         #define SERRF_PARITYERROR    0      /**< Parity error, unsupported in emulated serial port. */
  67         #define SERRF_NOISEERROR     0      /**< Noise error, unsupported in emulated serial port. */
  68
  69         enum
  70         {
  71                 SER_UART0,
  72                 SER_UART1,
  73
  74                 SER_CNT  /**< Number of serial ports */
  75         };
  76
  77 #else
  78         #include CPU_HEADER(ser)
  79 #endif
  80
  81 #include "cfg/cfg_ser.h"
  82
  83
  84
  85 /**
  86  * \name Masks to group TX/RX errors.
  87  * \{
  88  */
  89 #define SERRF_RX \
  90         ( SERRF_RXFIFOOVERRUN \
  91         | SERRF_RXTIMEOUT \
  92         | SERRF_RXSROVERRUN \
  93         | SERRF_PARITYERROR \
  94         | SERRF_FRAMEERROR \
  95         | SERRF_NOISEERROR)       /**< All possible rx errors */
  96 #define SERRF_TX  (SERRF_TXTIMEOUT)  /**< All possible tx errors */
  97 /*\}*/
  98
  99 /**
 100  * \name LSB or MSB first data order for SPI driver.
 101  *
 102  * $WIZ$ ser_order_bit = "SER_MSB_FIRST", "SER_LSB_FIRST"
 103  */
 104 #define SER_MSB_FIRST 0
 105 #define SER_LSB_FIRST 1
 106
 107 /**
 108  * \name Parity settings for ser_setparity().
 109  *
 110  * \note Values are AVR-specific for performance reasons.
 111  *       Other processors should either decode them or
 112  *       redefine these macros.
 113  * \{
 114  */
 115 #define SER_PARITY_NONE  0
 116 #define SER_PARITY_EVEN  2
 117 #define SER_PARITY_ODD   3
 118 /*\}*/
 119
 120
 121 /**
 122  * \def CONFIG_SER_STROBE
 123  *
 124  * This is a debug facility that can be used to
 125  * monitor SER interrupt activity on an external pin.
 126  *
 127  * To use strobes, redefine the macros SER_STROBE_ON,
 128  * SER_STROBE_OFF and SER_STROBE_INIT and set
 129  * CONFIG_SER_STROBE to 1.
 130  */
 131 #if !defined(CONFIG_SER_STROBE) || !CONFIG_SER_STROBE
 132         #define SER_STROBE_ON    do {/*nop*/} while(0)
 133         #define SER_STROBE_OFF   do {/*nop*/} while(0)
 134         #define SER_STROBE_INIT  do {/*nop*/} while(0)
 135 #endif
 136
 137 struct SerialHardware;
 138
 139 /** Human-readable serial error descriptions */
 140 extern const char * const serial_errors[8];
 141
 142 /** Serial handle structure */
 143 typedef struct Serial
 144 {
 145         /** Serial have a KFile struct implementation **/
 146         KFile fd;
 147
 148         /** Physical port number */
 149         unsigned int unit;
 150
 151 #ifdef _DEBUG
 152         bool is_open;
 153 #endif
 154
 155         /**
 156          * \name Transmit and receive FIFOs.
 157          *
 158          * Declared volatile because handled asinchronously by interrupts.
 159          *
 160          * \{
 161          */
 162         FIFOBuffer txfifo;
 163         FIFOBuffer rxfifo;
 164         /* \} */
 165
 166 #if CONFIG_SER_RXTIMEOUT != -1
 167         ticks_t rxtimeout;
 168 #endif
 169 #if CONFIG_SER_TXTIMEOUT != -1
 170         ticks_t txtimeout;
 171 #endif
 172
 173         /** Holds the flags defined above.  Will be 0 when no errors have occurred. */
 174         volatile serstatus_t status;
 175
 176         /** Low-level interface to hardware. */
 177         struct SerialHardware* hw;
 178 } Serial;
 179
 180
 181 /**
 182  * ID for serial.
 183  */
 184 #define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')
 185
 186
 187 INLINE Serial * SERIAL_CAST(KFile *fd)
 188 {
 189         ASSERT(fd->_type == KFT_SERIAL);
 190         return (Serial *)fd;
 191 }
 192
 193 /* Function prototypes */
 194 //extern int ser_getchar_nowait(struct Serial *port);
 195
 196 void ser_setbaudrate(struct Serial *fd, unsigned long rate);
 197 void ser_setparity(struct Serial *fd, int parity);
 198 void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout);
 199 void ser_resync(struct Serial *fd, mtime_t delay);
 200 int ser_getchar_nowait(struct Serial *fd);
 201
 202 void ser_purgeRx(struct Serial *fd);
 203 void ser_purgeTx(struct Serial *fd);
 204 void ser_purge(struct Serial *fd);
 205 void ser_init(struct Serial *fds, unsigned int unit);
 206 void spimaster_init(Serial *fds, unsigned int unit);
 207
 208
 209 /**
 210  * \name Additional functions implemented as macros
 211  *
 212  * \{
 213  */
 214 #define ser_getstatus(serial)    ((serial)->status)
 215 #define ser_setstatus(serial, new_status) ((serial)->status = (new_status))
 216 /* \} */
 217
 218 #endif /* DRV_SER_H */