ser.h

Go to the documentation of this file.

#ifndef DRV_SER_H
#define DRV_SER_H

#include <kern/kfile.h>
#include <struct/fifobuf.h>
#include <cfg/compiler.h>

#if OS_HOSTED
    #include <cfg/macros.h> /* BV() */

    typedef uint16_t serstatus_t;

    /* Software errors */
    #define SERRF_RXFIFOOVERRUN  BV(0)  
    #define SERRF_RXTIMEOUT      BV(1)  
    #define SERRF_TXTIMEOUT      BV(2)  
    /* Hardware errors */
    #define SERRF_RXSROVERRUN    0      
    #define SERRF_FRAMEERROR     0      
    #define SERRF_PARITYERROR    0      
    #define SERRF_NOISEERROR     0      
    enum
    {
        SER_UART0,
        SER_UART1,

        SER_CNT  
    };

#else
    #include CPU_HEADER(ser)
#endif

#include "cfg/cfg_ser.h"



#define SERRF_RX \
    ( SERRF_RXFIFOOVERRUN \
    | SERRF_RXTIMEOUT \
    | SERRF_RXSROVERRUN \
    | SERRF_PARITYERROR \
    | SERRF_FRAMEERROR \
    | SERRF_NOISEERROR)
#define SERRF_TX  (SERRF_TXTIMEOUT)
/*\}*/

#define SER_MSB_FIRST 0
#define SER_LSB_FIRST 1

#define SER_PARITY_NONE  0
#define SER_PARITY_EVEN  2
#define SER_PARITY_ODD   3
/*\}*/


#if !defined(CONFIG_SER_STROBE) || !CONFIG_SER_STROBE
    #define SER_STROBE_ON    do {/*nop*/} while(0)
    #define SER_STROBE_OFF   do {/*nop*/} while(0)
    #define SER_STROBE_INIT  do {/*nop*/} while(0)
#endif

struct SerialHardware;

extern const char * const serial_errors[8];

typedef struct Serial
{
    KFile fd;

    unsigned int unit;

#ifdef _DEBUG
    bool is_open;
#endif

    FIFOBuffer txfifo;
    FIFOBuffer rxfifo;
    /* \} */

#if CONFIG_SER_RXTIMEOUT != -1
    ticks_t rxtimeout;
#endif
#if CONFIG_SER_TXTIMEOUT != -1
    ticks_t txtimeout;
#endif

    volatile serstatus_t status;

    struct SerialHardware* hw;
} Serial;


#define KFT_SERIAL MAKE_ID('S', 'E', 'R', 'L')


INLINE Serial * SERIAL_CAST(KFile *fd)
{
    ASSERT(fd->_type == KFT_SERIAL);
    return (Serial *)fd;
}

/* Function prototypes */
//extern int ser_getchar_nowait(struct Serial *port);

void ser_setbaudrate(struct Serial *fd, unsigned long rate);
void ser_setparity(struct Serial *fd, int parity);
void ser_settimeouts(struct Serial *fd, mtime_t rxtimeout, mtime_t txtimeout);
void ser_resync(struct Serial *fd, mtime_t delay);
int ser_getchar_nowait(struct Serial *fd);

void ser_purgeRx(struct Serial *fd);
void ser_purgeTx(struct Serial *fd);
void ser_purge(struct Serial *fd);
void ser_init(struct Serial *fds, unsigned int unit);
void spimaster_init(Serial *fds, unsigned int unit);


#define ser_getstatus(h)    ((h)->status)
#define ser_setstatus(h, x) ((h)->status = (x))
/* \} */

#endif /* DRV_SER_H */