avr_uart.h

Go to the documentation of this file.

/*
 *  avr_uart.h
 * 
 *  Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
 * 
 *  This file is part of simavr.
 * 
 *  simavr is free software: you can redistribute it and/or modify it under the terms of the GNU
 *  General Public License as published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 * 
 *  simavr is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 *  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 *  Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License along with simavr.  If not, see
 *  <http://www.gnu.org/licenses/>.
 */

#ifndef __AVR_UART_H__
#define __AVR_UART_H__

#ifdef __cplusplus
extern "C"
{
#endif

#include "sim_avr.h"

#include "fifo_declare.h"

  DECLARE_FIFO (uint8_t, uart_fifo, 64);

  enum
    {
      UART_IRQ_INPUT = 0,
      UART_IRQ_OUTPUT,
      UART_IRQ_OUT_XON,   
      UART_IRQ_OUT_XOFF,   
      UART_IRQ_COUNT
    };

#define AVR_IOCTL_UART_GETIRQ(_name) AVR_IOCTL_DEF('u','a','r',(_name))

  enum
    {
      AVR_UART_FLAG_POOL_SLEEP = (1 << 0),
      AVR_UART_FLAG_STDIO = (1 << 1),   
    };

  typedef struct avr_uart_t
  {
    avr_io_t io;
    char name;
    avr_regbit_t disabled;   

    avr_io_addr_t r_udr;
    avr_io_addr_t r_ucsra;
    avr_io_addr_t r_ucsrb;
    avr_io_addr_t r_ucsrc;

    avr_regbit_t rxen;   
    avr_regbit_t txen;   
    avr_regbit_t u2x;   
    avr_regbit_t usbs;   
    avr_regbit_t ucsz;   
    avr_regbit_t ucsz2;   

    avr_io_addr_t r_ubrrl, r_ubrrh;

    avr_int_vector_t rxc;
    avr_int_vector_t txc;
    avr_int_vector_t udrc;

    uart_fifo_t input;

    uint32_t flags;
    avr_cycle_count_t usec_per_byte;

    uint8_t *stdio_out;
    int stdio_len;   
  } avr_uart_t;

  // takes a uint32_t* as parameter
#define AVR_IOCTL_UART_SET_FLAGS(_name) AVR_IOCTL_DEF('u','a','s',(_name))
#define AVR_IOCTL_UART_GET_FLAGS(_name) AVR_IOCTL_DEF('u','a','g',(_name))

  void avr_uart_init (avr_t * avr, avr_uart_t * port);

#ifdef __cplusplus
};
#endif

#endif /*__AVR_UART_H__*/