packages/hal/sh/sh3/v2_0/include/sh3_scif.h

   1 //=============================================================================
   2 //
   3 //      sh3_scif.h
   4 //
   5 //      Simple driver for the SH3 Serial Communication Interface with FIFO
   6 //
   7 //=============================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //=============================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):   jskov
  44 // Contributors:jskov
  45 // Date:        2000-03-30
  46 // Description: Simple driver for the SH Serial Communication Interface
  47 //              The driver can be used for either the SCIF or the IRDA
  48 //              modules (the latter can act as the former).
  49 //              Clients of this file can configure the behavior with:
  50 //              CYGNUM_SCIF_PORTS: number of SCI ports
  51 //
  52 // Note:        It should be possible to configure a channel to IRDA mode.
  53 //              Worry about that when some board needs it.
  54 //
  55 //####DESCRIPTIONEND####
  56 //
  57 //=============================================================================
  58
  59 #include <pkgconf/hal.h>
  60
  61 #ifdef CYGNUM_HAL_SH_SH3_SCIF_PORTS
  62
  63 //--------------------------------------------------------------------------
  64 // Exported functions
  65
  66 externC cyg_uint8 cyg_hal_plf_scif_getc(void* __ch_data);
  67 externC void cyg_hal_plf_scif_putc(void* __ch_data, cyg_uint8 c);
  68 void cyg_hal_plf_scif_init(int scif_index, int comm_index,
  69                            int rcv_vect, cyg_uint8* base);
  70
  71 #ifdef CYGPRI_HAL_SH_SH3_SCIF_PRIVATE
  72
  73 //--------------------------------------------------------------------------
  74 // SCIF register offsets
  75 #define _REG_SCSMR  0x00
  76 #define _REG_SCBRR  0x02
  77 #define _REG_SCSCR  0x04
  78 #define _REG_SCFTDR 0x06
  79 #define _REG_SCSSR  0x08
  80 #define _REG_SCFRDR 0x0a
  81 #define _REG_SCFCR  0x0c
  82 #define _REG_SCFDR  0x0e
  83
  84 //--------------------------------------------------------------------------
  85
  86 typedef struct {
  87     cyg_uint8* base;
  88     cyg_int32 msec_timeout;
  89     int isr_vector;
  90 } channel_data_t;
  91
  92 //--------------------------------------------------------------------------
  93
  94 #if !defined(CYGSEM_HAL_VIRTUAL_VECTOR_DIAG)
  95 // This one should only be used by old-stub compatibility code!
  96 externC void cyg_hal_plf_scif_init_channel(channel_data_t* chan);
  97 #warning "You should not be using anything but vv diag"
  98 #endif
  99
 100 #endif // CYGPRI_HAL_SH_SH3_SCIF_PRIVATE
 101
 102 #endif // CYGNUM_HAL_SH_SH3_SCIF_PORTS
 103 //-----------------------------------------------------------------------------
 104 // end of sh3_scif.h