//==========================================================================
//
//      io/serial/arm/study_serial.c
//
//      ARM AEB-2 Serial I/O Interface Module (interrupt driven)
//
//==========================================================================
//####ECOSGPLCOPYRIGHTBEGIN####
// -------------------------------------------
// This file is part of eCos, the Embedded Configurable Operating System.
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
//
// eCos 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 2 or (at your option) any later version.
//
// eCos 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 eCos; if not, write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
//
// As a special exception, if other files instantiate templates or use macros
// or inline functions from this file, or you compile this file and link it
// with other works to produce a work based on this file, this file does not
// by itself cause the resulting work to be covered by the GNU General Public
// License. However the source code for this file must still be made available
// in accordance with section (3) of the GNU General Public License.
//
// This exception does not invalidate any other reasons why a work based on
// this file might be covered by the GNU General Public License.
//
// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
// at http://sources.redhat.com/ecos/ecos-license/
// -------------------------------------------
//####ECOSGPLCOPYRIGHTEND####
// ====================================================================
//#####DESCRIPTIONBEGIN####
//
// Author(s):    Lars.Lindqvist@combitechsystems.com
// Contributors: jlarmour
// Date:         2001-10-19
// Purpose:      ARM AEB-2 Serial I/O Interface Module (interrupt driven)
// Description:
//
//####DESCRIPTIONEND####
//
// ====================================================================

#include <pkgconf/system.h>
#include <pkgconf/io_serial.h>
#include <pkgconf/io.h>
#include <cyg/io/io.h>
#include <cyg/hal/hal_intr.h>
#include <cyg/io/devtab.h>
#include <cyg/io/serial.h>
#include <cyg/io/serialio.h>
#include <cyg/infra/diag.h>

#ifdef CYGPKG_IO_SERIAL_ARM_study

#include "study_serial.h"

typedef struct study_serial_info {
    CYG_ADDRWORD   base;
    CYG_WORD       tx_int_num;
    CYG_WORD       rx_int_num;
    cyg_interrupt  serial_tx_interrupt;
    cyg_interrupt  serial_rx_interrupt;
    cyg_handle_t   serial_tx_interrupt_handle;
    cyg_handle_t   serial_rx_interrupt_handle;
    bool           tx_enabled;
} study_serial_info;

static bool study_serial_init(struct cyg_devtab_entry *tab);
static bool study_serial_putc(serial_channel *chan, unsigned char c);
static Cyg_ErrNo study_serial_lookup(struct cyg_devtab_entry **tab, 
                                   struct cyg_devtab_entry *sub_tab,
                                   const char *name);
static unsigned char study_serial_getc(serial_channel *chan);
static Cyg_ErrNo study_serial_set_config(serial_channel *chan, 
                                       cyg_uint32 key,
                                       const void *xbuf, cyg_uint32 *len);
static void study_serial_start_xmit(serial_channel *chan);
static void study_serial_stop_xmit(serial_channel *chan);

static cyg_uint32 study_serial_tx_ISR(cyg_vector_t vector, cyg_addrword_t data);
static void       study_serial_tx_DSR(cyg_vector_t vector, cyg_ucount32 count, cyg_addrword_t data);
static cyg_uint32 study_serial_rx_ISR(cyg_vector_t vector, cyg_addrword_t data);
static void       study_serial_rx_DSR(cyg_vector_t vector, cyg_ucount32 count, cyg_addrword_t data);

static SERIAL_FUNS(study_serial_funs, 
                   study_serial_putc, 
                   study_serial_getc,
                   study_serial_set_config,
                   study_serial_start_xmit,
                   study_serial_stop_xmit
    );

#ifdef CYGPKG_IO_SERIAL_ARM_study_SERIAL0
static study_serial_info study_serial_info0 = {0x01d00000, 
                                           CYGNUM_HAL_INTERRUPT_UART0_TX,
                                           CYGNUM_HAL_INTERRUPT_UART0_RX};
#if CYGNUM_IO_SERIAL_ARM_study_SERIAL0_BUFSIZE > 0
static unsigned char study_serial_out_buf0[CYGNUM_IO_SERIAL_ARM_study_SERIAL0_BUFSIZE];
static unsigned char study_serial_in_buf0[CYGNUM_IO_SERIAL_ARM_study_SERIAL0_BUFSIZE];

static SERIAL_CHANNEL_USING_INTERRUPTS(study_serial_channel0,
                                       study_serial_funs, 
                                       study_serial_info0,
                                       CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_ARM_study_SERIAL0_BAUD),
                                       CYG_SERIAL_STOP_DEFAULT,
                                       CYG_SERIAL_PARITY_DEFAULT,
                                       CYG_SERIAL_WORD_LENGTH_DEFAULT,
                                       CYG_SERIAL_FLAGS_DEFAULT,
                                       &study_serial_out_buf0[0], sizeof(study_serial_out_buf0),
                                       &study_serial_in_buf0[0], sizeof(study_serial_in_buf0)
    );
#else
static SERIAL_CHANNEL(study_serial_channel0,
                      study_serial_funs, 
                      study_serial_info0,
                      CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_ARM_study_SERIAL0_BAUD),
                      CYG_SERIAL_STOP_DEFAULT,
                      CYG_SERIAL_PARITY_DEFAULT,
                      CYG_SERIAL_WORD_LENGTH_DEFAULT,
                      CYG_SERIAL_FLAGS_DEFAULT
    );
#endif

DEVTAB_ENTRY(study_serial_io0, 
             CYGDAT_IO_SERIAL_ARM_study_SERIAL0_NAME,
             0,                     // Does not depend on a lower level interface
             &cyg_io_serial_devio, 
             study_serial_init, 
             study_serial_lookup,     // Serial driver may need initializing
             &study_serial_channel0
    );
#endif //  CYGPKG_IO_SERIAL_ARM_study_SERIAL0

#ifdef CYGPKG_IO_SERIAL_ARM_study_SERIAL1
static study_serial_info study_serial_info1 = {0x01d04000,
                                           CYGNUM_HAL_INTERRUPT_UART1_TX,
                                           CYGNUM_HAL_INTERRUPT_UART1_RX};
#if CYGNUM_IO_SERIAL_ARM_study_SERIAL1_BUFSIZE > 0
static unsigned char study_serial_out_buf1[CYGNUM_IO_SERIAL_ARM_study_SERIAL1_BUFSIZE];
static unsigned char study_serial_in_buf1[CYGNUM_IO_SERIAL_ARM_study_SERIAL1_BUFSIZE];

static SERIAL_CHANNEL_USING_INTERRUPTS(study_serial_channel1,
                                       study_serial_funs, 
                                       study_serial_info1,
                                       CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_ARM_study_SERIAL1_BAUD),
                                       CYG_SERIAL_STOP_DEFAULT,
                                       CYG_SERIAL_PARITY_DEFAULT,
                                       CYG_SERIAL_WORD_LENGTH_DEFAULT,
                                       CYG_SERIAL_FLAGS_DEFAULT,
                                       &study_serial_out_buf1[0], sizeof(study_serial_out_buf1),
                                       &study_serial_in_buf1[0], sizeof(study_serial_in_buf1)
    );
#else
static SERIAL_CHANNEL(study_serial_channel1,
                      study_serial_funs, 
                      study_serial_info1,
                      CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_ARM_study_SERIAL1_BAUD),
                      CYG_SERIAL_STOP_DEFAULT,
                      CYG_SERIAL_PARITY_DEFAULT,
                      CYG_SERIAL_WORD_LENGTH_DEFAULT,
                      CYG_SERIAL_FLAGS_DEFAULT
    );
#endif

DEVTAB_ENTRY(study_serial_io1, 
             CYGDAT_IO_SERIAL_ARM_study_SERIAL1_NAME,
             0,                     // Does not depend on a lower level interface
             &cyg_io_serial_devio, 
             study_serial_init, 
             study_serial_lookup,     // Serial driver may need initializing
             &study_serial_channel1
    );
#endif //  CYGPKG_IO_SERIAL_ARM_study_SERIAL1

// Internal function to actually configure the hardware to desired baud rate, etc.
static bool
study_serial_config_port(serial_channel *chan, cyg_serial_info_t *new_config, bool init)
{