usart.h

Go to the documentation of this file.

#ifndef _DEV_USART_H_
#define _DEV_USART_H_

/*
 * Copyright (C) 2001-2003 by egnite Software GmbH. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * For additional information see http://www.ethernut.de/
 */

/*
 * $Log$
 * Revision 1.7  2008/08/11 06:59:59  haraldkipp
 * BSD types replaced by stdint types (feature request #1282721).
 *
 * Revision 1.6  2004/11/12 11:55:39  freckle
 * marked rbf_blockcnt and rbf_blockptr as volatile
 *
 * Revision 1.5  2004/11/12 11:25:43  freckle
 * added rbf_blockcnt and rbf_blockptr to _RINGBUF (if UART_BLOCKING_READ is
 * defined). added USART_MF_BLOCKREAD mode define
 *
 * Revision 1.4  2004/11/08 18:14:09  haraldkipp
 * Marked RINGBUF members volatile, which are modified within
 * interrupt routines.
 *
 * Revision 1.3  2004/05/24 20:19:49  drsung
 * Added function UsartSize to return number of chars in input buffer.
 *
 * Revision 1.2  2004/03/16 16:48:28  haraldkipp
 * Added Jan Dubiec's H8/300 port.
 *
 * Revision 1.1  2003/12/18 09:33:58  haraldkipp
 * First check in
 *
 */

#include <dev/uart.h>



#ifndef USART_RXBUFSIZ
#define USART_RXBUFSIZ    256
#endif

#ifndef USART_RXHIWMARK
#define USART_RXHIWMARK   240
#endif

#ifndef USART_RXLOWMARK
#define USART_RXLOWMARK   208
#endif

#ifndef USART_TXBUFSIZ
#define USART_TXBUFSIZ    64
#endif

#ifndef USART_TXHIWMARK
#define USART_TXHIWMARK   56
#endif

#ifndef USART_TXLOWMARK
#define USART_TXLOWMARK   40
#endif

#ifndef ENABLE
#define ENABLE 1
#endif

#ifndef DISABLE
#define DISABLE 0
#endif


typedef struct _RINGBUF RINGBUF;

struct _RINGBUF {

    uint8_t * volatile rbf_head;

    uint8_t * volatile rbf_tail;

    uint8_t *rbf_start;

    uint8_t *rbf_last;

    size_t rbf_siz;

    volatile size_t rbf_cnt;

    size_t rbf_lwm;

    size_t rbf_hwm;

    HANDLE rbf_que;

    size_t volatile rbf_blockcnt;

    uint8_t* volatile rbf_blockptr;
};


#define USART_INITSPEED   115200

#define USART_MF_RTSCONTROL     0x0001  
#define USART_MF_CTSSENSE       0x0002  
#define USART_MF_DTRCONTROL     0x0004  
#define USART_MF_DSRSENSE       0x0008  
#define USART_MF_DCDSENSE       0x0010  
#define USART_MF_SENSEMASK      0x001A  
#define USART_MF_CONTROLMASK    0x0005  
#define USART_MF_XONXOFF        0x0020

#define USART_MF_LOCALECHO      0x0040  
#define USART_MF_COOKEDMODE     0x0080  
#define USART_MF_NOBUFFER       0x0100  
#define USART_MF_LINEBUFFER     0x0200  
#define USART_MF_BUFFERMASK     0x0300  
#define USART_MF_HALFDUPLEX     0x0400  
#define USART_MF_BLOCKREAD      0x0800  
#define USART_MF_BLOCKWRITE     0x1000  
#define USART_MF_FLOWMASK       (USART_MF_XONXOFF| USART_MF_HALFDUPLEX|USART_MF_LOCALECHO|USART_MF_BLOCKREAD|USART_MF_BLOCKWRITE)

#define USART_SF_RTSOFF         0x0001  
#define USART_SF_CTSOFF         0x0002  
#define USART_SF_DTROFF         0x0004  
#define USART_SF_DSROFF         0x0008  
#define USART_SF_DCDOFF         0x0010  
#define USART_SF_TXDISABLED     0x0040  
#define USART_SF_RXDISABLED     0x0080  
struct _USARTDCB {

    uint32_t dcb_modeflags;

    uint32_t dcb_statusflags;

    uint32_t dcb_rtimeout;

    uint32_t dcb_wtimeout;

    RINGBUF dcb_tx_rbf;

    RINGBUF dcb_rx_rbf;

    uint8_t dcb_last_eol;

    int (*dcb_init) (void);

    int (*dcb_deinit) (void);

    void (*dcb_tx_start) (void);

    void (*dcb_rx_start) (void);

    int (*dcb_set_flow_control) (uint32_t flags);

     uint32_t(*dcb_get_flow_control) (void);

    int (*dcb_set_speed) (uint32_t rate);

     uint32_t(*dcb_get_speed) (void);

    int (*dcb_set_data_bits) (uint8_t bits);

     uint8_t(*dcb_get_data_bits) (void);

    int (*dcb_set_parity) (uint8_t bits);

     uint8_t(*dcb_get_parity) (void);

    int (*dcb_set_stop_bits) (uint8_t bits);

     uint8_t(*dcb_get_stop_bits) (void);

    int (*dcb_set_status) (uint32_t flags);

     uint32_t(*dcb_get_status) (void);

    int (*dcb_set_clock_mode) (uint8_t mode);

     uint8_t(*dcb_get_clock_mode) (void);
};

typedef struct _USARTDCB USARTDCB;

extern int UsartInit(NUTDEVICE * dev);
extern int UsartIOCtl(NUTDEVICE * dev, int req, void *conf);
extern int UsartRead(NUTFILE * fp, void *buffer, int size);
extern int UsartWrite(NUTFILE * fp, const void *buffer, int len);
#ifdef __HARVARD_ARCH__
extern int UsartWrite_P(NUTFILE * fp, PGM_P buffer, int len);
#endif
extern NUTFILE *UsartOpen(NUTDEVICE * dev, const char *name, int mode, int acc);
extern int UsartClose(NUTFILE * fp);
extern long UsartSize (NUTFILE *fp);

#endif