mcf5272_serial.c

来自「开放源码实时操作系统源码.」· C语言 代码 · 共 1,138 行 · 第 1/3 页

//==========================================================================
//
//      devs/serial/coldfire/mcf5272/mcf5272_serial.c
//
//      ColdFire MCF5272 UART 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.
// Copyright (C) 2006 eCosCentric Ltd.
//
// 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.
// -------------------------------------------
//####ECOSGPLCOPYRIGHTEND####
//==========================================================================
//#####DESCRIPTIONBEGIN####
//
// Author(s):    Wade Jensen, Enrico Piria
// Contributors: 
// Date:         2005-06-25
// Purpose:      MCF5272 Serial I/O module (interrupt driven version).
// 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/infra/diag.h>
#include <pkgconf/hal.h>
#include <cyg/infra/cyg_type.h>
#include <string.h> // memset, strcmp

#include "mcf5272_serial.h"


// Use this macro to determine if at least one of the ports uses
// autobaud detection.
#if defined(CYGOPT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_AUTOBAUD) || \
    defined(CYGOPT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_AUTOBAUD)
#define REQUESTED_AUTOBAUD
#endif

// Autobaud states
typedef enum autobaud_states_t
{
    AB_IDLE = 0,      // Normal state. Autobaud process hasn't been initiated yet.
    AB_BEGIN_BREAK,   // Detected a start of the break.
    AB_BEGIN,         // Detected the end of the break and has set up the autobaud.
    AB_DISABLED       // Autobaud detection disabled for this port.
} autobaud_states_t;

typedef struct MCF5272_uart_info_t
{
    volatile mcf5272_uart_t         *base;                      // Base address of the UART registers
    cyg_uint32                      uart_vector;                // UART interrupt vector number

    cyg_interrupt                   serial_interrupt;           // Interrupt context
    cyg_handle_t                    serial_interrupt_handle;    // Interrupt handle

    volatile cyg_uint8              imr_mirror;                 // Interrupt mask register mirror

    cyg_serial_info_t               config;                     // The channel configuration

    autobaud_states_t               autobaud_state;             // The autobaud state


} MCF5272_uart_info_t;

// Function prototypes for the MCF5272 UART ISR and DSR.
static cyg_uint32 MCF5272_uart_ISR(cyg_vector_t vector, cyg_addrword_t data);
static void MCF5272_uart_DSR(cyg_vector_t vector, cyg_ucount32 count, cyg_addrword_t data);

// Function prototypes for the serial functions.
static bool MCF5272_uart_init(struct cyg_devtab_entry * tab);
static Cyg_ErrNo MCF5272_uart_lookup(struct cyg_devtab_entry **tab,
    struct cyg_devtab_entry *sub_tab, const char *name);
static bool MCF5272_uart_putc(serial_channel *chan, unsigned char c);
static unsigned char MCF5272_uart_getc(serial_channel *chan);
Cyg_ErrNo MCF5272_uart_set_config(serial_channel *chan, cyg_uint32 key,
    const void *xbuf, cyg_uint32 *len);
static void MCF5272_uart_start_xmit(serial_channel *chan);
static void MCF5272_uart_stop_xmit(serial_channel * chan);

// Declare the serial functions that are called by the common serial
// driver layer.
static SERIAL_FUNS
(
    MCF5272_uart_funs,
    MCF5272_uart_putc,
    MCF5272_uart_getc,
    MCF5272_uart_set_config,
    MCF5272_uart_start_xmit,
    MCF5272_uart_stop_xmit
);


// Definition for channel 0 UART configuration.
//***********************************************
#ifdef CYGPKG_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0

// Data structure contains channel information.
static MCF5272_uart_info_t MCF5272_uart_channel_info_0;

// If the channel buffer size is zero, do not include interrupt UART processing
#if CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_BUFSIZE > 0

// Allocate receive and transmit buffer. The size of the buffer  is
// configured by the configtool.
static unsigned char 
MCF5272_uart_out_buf0[CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_BUFSIZE];
static unsigned char 
MCF5272_uart_in_buf0[CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_BUFSIZE];

// Channel function table. We register the UART functions here so
// that uppper serial drivers can call the serial driver's routines.
static SERIAL_CHANNEL_USING_INTERRUPTS(
    MCF5272_uart_channel_0,
    MCF5272_uart_funs,
    MCF5272_uart_channel_info_0,
    CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_BAUD),
    CYG_SERIAL_STOP_DEFAULT,
    CYG_SERIAL_PARITY_DEFAULT,
    CYG_SERIAL_WORD_LENGTH_DEFAULT,
    CYG_SERIAL_FLAGS_DEFAULT,
    MCF5272_uart_out_buf0, sizeof(MCF5272_uart_out_buf0),
    MCF5272_uart_in_buf0, sizeof(MCF5272_uart_in_buf0)
);

#else

// Don't use interrupt processing for the UART.
static SERIAL_CHANNEL(
    MCF5272_uart_channel_0,
    MCF5272_uart_funs,
    MCF5272_uart_channel_info_0,
    CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_BAUD),
    CYG_SERIAL_STOP_DEFAULT,
    CYG_SERIAL_PARITY_DEFAULT,
    CYG_SERIAL_WORD_LENGTH_DEFAULT,
    CYG_SERIAL_FLAGS_DEFAULT
);
#endif

DEVTAB_ENTRY(
    MCF5272_uart_io0,
    CYGDAT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_NAME,
    0,                       // Does not depend on a lower level interface
    &cyg_io_serial_devio,    // The table of I/O functions.
    MCF5272_uart_init,       // UART initialization function.
    MCF5272_uart_lookup,     // The UART lookup function. This
                             // function typically sets
                             // up the device for actual use, 
                             // turning on interrupts,
                             // configuring the port, etc.
    &MCF5272_uart_channel_0
);
#endif // ifdef CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0


// Definition for channel 1 UART configuration.
//***********************************************
#ifdef CYGPKG_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1

// Data structure contains channel informtion.
static MCF5272_uart_info_t MCF5272_uart_channel_info_1;

// If the channel buffer size is zero, do not include interrupt UART processing
#if CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_BUFSIZE > 0

// Allocate receive and transmit buffer. The size of the buffer  is
// configured by the configtool.
static unsigned char 
MCF5272_uart_out_buf1[CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_BUFSIZE];
static unsigned char 
MCF5272_uart_in_buf1[CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_BUFSIZE];

// Channel function table. We register the UART functions here so
// that uppper serial drivers can call the serial driver's routines.
static SERIAL_CHANNEL_USING_INTERRUPTS(
    MCF5272_uart_channel_1,
    MCF5272_uart_funs,
    MCF5272_uart_channel_info_1,
    CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_BAUD),
    CYG_SERIAL_STOP_DEFAULT,
    CYG_SERIAL_PARITY_DEFAULT,
    CYG_SERIAL_WORD_LENGTH_DEFAULT,
    CYG_SERIAL_FLAGS_DEFAULT,
    MCF5272_uart_out_buf1, sizeof(MCF5272_uart_out_buf1),
    MCF5272_uart_in_buf1, sizeof(MCF5272_uart_in_buf1)
);

#else

static SERIAL_CHANNEL(
    MCF5272_uart_channel_1,
    MCF5272_uart_funs,
    MCF5272_uart_channel_info_1,
    CYG_SERIAL_BAUD_RATE(CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_BAUD),
    CYG_SERIAL_STOP_DEFAULT,
    CYG_SERIAL_PARITY_DEFAULT,
    CYG_SERIAL_WORD_LENGTH_DEFAULT,
    CYG_SERIAL_FLAGS_DEFAULT
);
#endif

DEVTAB_ENTRY(
    MCF5272_uart_io1,
    CYGDAT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_NAME,
    0,                     // Does not depend on a lower level interface
    &cyg_io_serial_devio,  // The table of I/O functions.
    MCF5272_uart_init,     // UART initialization function.
    MCF5272_uart_lookup,   // The UART lookup function. This function 
                           // typically sets up the device for actual use, 
                           // turing on interrupts, configuring the port, etc.
    &MCF5272_uart_channel_1
);
#endif // ifdef CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1


// Function Prototypes

// Internal function to actually configure the hardware to desired
// baud rate, etc.
static bool MCF5272_uart_config_port(serial_channel*, cyg_serial_info_t*);
static void MCF5272_uart_start_xmit(serial_channel*);


// The table contains  dividers  to  divide  the  clock  to  configure  an
// approppriate baud rate for the UART.

#define DIVIDER(_baudrate_) \
    ((CYGHWR_HAL_SYSTEM_CLOCK_MHZ * 1000000) / ((_baudrate_) * 32))

static unsigned long dividers_table[]=
{
    0,
    DIVIDER(50),        // CYGNUM_SERIAL_BAUD_50 = 1
    DIVIDER(75),        // CYGNUM_SERIAL_BAUD_75
    DIVIDER(110),       // CYGNUM_SERIAL_BAUD_110
    DIVIDER(134.5),     // CYGNUM_SERIAL_BAUD_134_5
    DIVIDER(150),       // CYGNUM_SERIAL_BAUD_150
    DIVIDER(200),       // CYGNUM_SERIAL_BAUD_200
    DIVIDER(300),       // CYGNUM_SERIAL_BAUD_300
    DIVIDER(600),       // CYGNUM_SERIAL_BAUD_600
    DIVIDER(1200),      // CYGNUM_SERIAL_BAUD_1200
    DIVIDER(1800),      // CYGNUM_SERIAL_BAUD_1800
    DIVIDER(2400),      // CYGNUM_SERIAL_BAUD_2400
    DIVIDER(3600),      // CYGNUM_SERIAL_BAUD_3600
    DIVIDER(4800),      // CYGNUM_SERIAL_BAUD_4800
    DIVIDER(7200),      // CYGNUM_SERIAL_BAUD_7200
    DIVIDER(9600),      // CYGNUM_SERIAL_BAUD_9600
    DIVIDER(14400),     // CYGNUM_SERIAL_BAUD_14400
    DIVIDER(19200),     // CYGNUM_SERIAL_BAUD_19200
    DIVIDER(38400),     // CYGNUM_SERIAL_BAUD_38400
    DIVIDER(57600),     // CYGNUM_SERIAL_BAUD_57600
    DIVIDER(115200),    // CYGNUM_SERIAL_BAUD_115200
    DIVIDER(230400)     // CYGNUM_SERIAL_BAUD_230400
};


// ****************************************************************************
// MCF5272_uart_init() - This routine is called during bootstrap to set up the
//                       UART driver.
//
// INPUT:
//    Pointer to the the device table.
//
// RETURN:
//    Returns true if the initialization is successful. Otherwise, it retuns 
//    false.

static bool MCF5272_uart_init(struct cyg_devtab_entry * tab)
{
    serial_channel *chan = (serial_channel *) tab->priv;
    MCF5272_uart_info_t *port = (MCF5272_uart_info_t *) chan->dev_priv;
    int priority_level = 0;


#ifdef CYGPKG_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0

    // Instantiation of the UART channel 0 data structure. This data
    // structure contains channel information.
    if (strcmp(tab->name, CYGDAT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_NAME) 
        == 0)
    {

        cyg_uint32 pbcnt;
        
        // A priority makes sense only if interrupts are enabled
#ifdef CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_PRIORITY
        priority_level = CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_PRIORITY;
#else
        priority_level = 0;
#endif

        // Initialize the UART information data to all zeros
        memset(port, sizeof(MCF5272_uart_info_t), 0);

        // Set the base address of the UART registers to differentiate
        // itself from the different registers for the other UART port.
        port->base = (mcf5272_uart_t *) &MCF5272_DEVS->uart[0];

        // Set the UART interrupt vector number
        port->uart_vector = CYGNUM_HAL_INTERRUPT_UART1;

#ifdef CYGOPT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0_AUTOBAUD

        // Set the autobaud state to idle
        port->autobaud_state = AB_IDLE;
#else
        // Disable autobaud detection for this port
        port->autobaud_state = AB_DISABLED;
#endif

        // Initialize the UART 0 output pins
        HAL_READ_UINT32(&MCF5272_DEVS->gpio.pbcnt, pbcnt);
        HAL_WRITE_UINT32(&MCF5272_DEVS->gpio.pbcnt, 
                         MCF5272_GPIO_PBCNT_URT0_EN |
                         (pbcnt & ~MCF5272_GPIO_PBCNT_URT0_MSK));
    }
#endif // CYGPKG_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL0

#ifdef CYGPKG_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1

    // Instantiation of the UART channel 1 data strucutre. This data
    // structure contains channel information.
    if (strcmp(tab->name, CYGDAT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_NAME) 
        == 0)
    {
        cyg_uint32 pdcnt;
        
        // A priority makes sense only if interrupts are enabled
#ifdef CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_PRIORITY
        priority_level = CYGNUM_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_PRIORITY;
#else
        priority_level = 0;
#endif

        // Initialize the UART information data to all zeros
        memset(port, sizeof(MCF5272_uart_info_t), 0);

        // Set the base address of the UART registers to differentiate
        // itself from the different regusters for the other UART port.
        port->base = (mcf5272_uart_t *) &MCF5272_DEVS->uart[1];

        // Set the UART interrupt vector number
        port->uart_vector = CYGNUM_HAL_INTERRUPT_UART2;

#ifdef CYGOPT_IO_SERIAL_COLDFIRE_MCF5272_CHANNEL1_AUTOBAUD

        // Set the autobaud state to idle