uart.h

Jan 04, 2007 1. Add SPI support, see spi.h and spi.c 2. Add driver.h 3. Modified keyboard modu

/**
 * Copyright (c) 2006-2008 iWESUN (ShenZhen) Inf.
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * This file is part of the AvrcX MTOS
 * 
 * Author: Winter Hu  <[e-mail]>
 * Create: Dec 25, 2006
 */


#ifndef __UART_H__
#define __UART_H__

#include "avrcx.h"


#define UART_TXBUF_SIZE 16
#define UART_RXBUF_SIZE 16

#define UART_RECVDATA 1
#define UART_RX_FULLY 2  // Buffer is fully
#define UART_TX_EMPTY 4  // Buffer is empty

#ifndef __ASSEMBLER__
/* These only work in C program */

/**
 * Uart will callback this method when uart status had changed
 *
 * @param unsigned char, The status of transfer
 */
typedef void (*uart_hook)(unsigned char);

typedef struct UartControlBlock {
  __volatile__ unsigned char status;
  uart_hook hook;
  ByteFifo* txbuf;
  ByteFifo* rxbuf;
} UARTCB;

/**
 * Initialize UART for Rx and Tx
 * You should invoke this method to initializ UART
 * Currently, this method just supported 8bit data, 1bit stop and none check
 *
 */
INTERFACE void init_uart(void);

/**
 * Register user's hook to UART driver
 *
 * @param uart_tx_hook, The hook to handle transfer event
 * @param uart_rx_hook, The hook to handle receive event
 */
INTERFACE void uart_set_hook(uart_hook);

/**
 * Put a char to UART Tx queue
 *
 * @param char, the char need put to UART
 * @return 0 is successful, other values are failed
 */
INTERFACE int uart_putchar(char b);

/**
 * Get a char from UART Rx queue
 *
 * @return the char, if equas to -1, there are some errors occur.
 */
INTERFACE int uart_getchar(void);

#endif /* ! __ASSEMBLER__ */

#endif /* __UART_H__ */