lunaix-os/includes/hal/serial.h

   1 #ifndef __LUNAIX_SERIAL_H
   2 #define __LUNAIX_SERIAL_H
   3
   4 #include <lunaix/device.h>
   5 #include <lunaix/ds/fifo.h>
   6 #include <lunaix/ds/llist.h>
   7 #include <lunaix/ds/mutex.h>
   8 #include <lunaix/ds/waitq.h>
   9
  10 #define SERIAL_RW_RX 0x0
  11 #define SERIAL_RW_TX 0x1
  12 #define io_dir(flags) ((flags) & SERIAL_RW_TX)
  13
  14 #define RXTX_DONE 0x1
  15 #define RXTX_WAIT 0x2
  16
  17 #define SERIAL_AGAIN 0x1
  18 #define SERIAL_DONE 0x0
  19
  20 struct serial_dev;
  21 typedef int (*rxtx_cb)(struct serial_dev*);
  22
  23 struct serial_dev
  24 {
  25     struct llist_header sdev_list;
  26     struct device* dev;
  27     mutex_t lock;
  28     struct waitq wq_rxdone;
  29     struct waitq wq_txdone;
  30     void* backend;
  31
  32     struct fifo_buf rxbuf;
  33     int wr_len;
  34
  35     /**
  36      * @brief Write buffer to TX. The return code indicate
  37      * the transaction is either done in synced mode (TX_DONE) or will be
  38      * done asynchronously (TX_WAIT).
  39      *
  40      */
  41     int (*write)(struct serial_dev* sdev, u8_t*, size_t);
  42     int (*exec_cmd)(struct serial_dev* sdev, u32_t, va_list);
  43 };
  44
  45 struct serial_dev*
  46 serial_create(struct devclass* class);
  47
  48 void
  49 serial_readone(struct serial_dev* sdev, u8_t* val);
  50
  51 int
  52 serial_readone_nowait(struct serial_dev* sdev, u8_t* val);
  53
  54 size_t
  55 serial_readbuf(struct serial_dev* sdev, u8_t* buf, size_t len);
  56
  57 int
  58 serial_readbuf_nowait(struct serial_dev* sdev, u8_t* buf, size_t len);
  59
  60 int
  61 serial_writebuf(struct serial_dev* sdev, u8_t* buf, size_t len);
  62
  63 int
  64 serial_writebuf_nowait(struct serial_dev* sdev, u8_t* buf, size_t len);
  65
  66 struct serial_dev*
  67 serial_get_avilable();
  68
  69 int
  70 serial_accept_one(struct serial_dev* sdev, u8_t val);
  71
  72 int
  73 serial_accept_buffer(struct serial_dev* sdev, void* val, size_t len);
  74
  75 void
  76 serial_end_recv(struct serial_dev* sdev);
  77
  78 void
  79 serial_end_xmit(struct serial_dev* sdev, size_t len);
  80
  81 #endif /* __LUNAIX_SERIAL_H */