lsd.h

/************************************************************************/
 
/*
 * Frame format is:
 *
 * STX : CH-LENH : LENL : DATA : ETX
 *
 * - STX and ETX are the start/end of transmission characters (1 byte each).
 * - CH-LENH is the channel number (first 4 bits) and the 4 high bits of the
 *   data length.
 * - LENL is the low 8 bits of the data length.
 * - DATA is the payload, of the previously specified length.
 */
#ifndef _LSD_H_
#define _LSD_H_
 
#include "config.h"
#include "types.h"
 
#if (MODULE_EVERDRIVE != 0)
        // use the everdrive uart 
        #include "ext/mw/ssf.h"
#else
        // use the default 16c550 uart
        #include "ext/mw/16c550.h"
#endif
#include "ext/mw/mw-msg.h"

#define LSD_OVERHEAD            4

#define LSD_MAX_CH              4

#define LSD_MAX_LEN              4095

#define LSD_BUF_FRAMES          2

enum lsd_status {
        LSD_STAT_ERR_FRAMING = -5,          
        LSD_STAT_ERR_INVALID_CH = -4,            
        LSD_STAT_ERR_FRAME_TOO_LONG = -3,    
        LSD_STAT_ERR_IN_PROGRESS = -2,          
        LSD_STAT_ERROR = -1,                      
        LSD_STAT_COMPLETE = 0,                 
        LSD_STAT_BUSY = 1                  
};

typedef void (*lsd_send_cb)(enum lsd_status stat, void *ctx);
typedef void (*lsd_recv_cb)(enum lsd_status stat, uint8_t ch,
                char *data, uint16_t len, void *ctx);
 
/************************************************************************/
void lsd_init(void);
 
/************************************************************************/
int lsd_ch_enable(uint8_t ch);
 
/************************************************************************/
int lsd_ch_disable(uint8_t ch);
 
 
/************************************************************************/
enum lsd_status lsd_send(uint8_t ch, const char *data, int16_t len,
                void *ctx, lsd_send_cb send_cb);
 
/************************************************************************/
enum lsd_status lsd_send_sync(uint8_t ch, const char *data, int16_t len);
 
/************************************************************************/
enum lsd_status lsd_recv(char *buf, int16_t len, void *ctx,
                lsd_recv_cb recv_cb);
 
/************************************************************************/
enum lsd_status lsd_recv_sync(char *buf, uint16_t *len, uint8_t *ch);
 
/************************************************************************/
void lsd_process(void);
 
/************************************************************************/
void lsd_line_sync(void);

 
#endif //_LSD_H_