sdcc/device/include/pic16/usart.h

   1 /*-------------------------------------------------------------------------
   2    usart.h - USART communications module library header
   3
   4    Copyright (C) 2005, Vangelis Rokas <vrokas AT otenet.gr>
   5
   6    This library is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any
   9    later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this library; see the file COPYING. If not, write to the
  18    Free Software Foundation, 51 Franklin Street, Fifth Floor, Boston,
  19    MA 02110-1301, USA.
  20
  21    As a special exception, if you link this library with other files,
  22    some of which are compiled with SDCC, to produce an executable,
  23    this library does not by itself cause the resulting executable to
  24    be covered by the GNU General Public License. This exception does
  25    not however invalidate any other reasons why the executable file
  26    might be covered by the GNU General Public License.
  27 -------------------------------------------------------------------------*/
  28
  29 #ifndef __USART_H__
  30 #define __USART_H__
  31
  32 #pragma library io
  33
  34
  35 #define RAM_SCLS        __data
  36
  37 /* configuration bit masks for open function */
  38 #define USART_TX_INT_ON   0xff
  39 #define USART_TX_INT_OFF  0x7f
  40 #define USART_RX_INT_ON   0xff
  41 #define USART_RX_INT_OFF  0xbf
  42 #define USART_BRGH_HIGH   0xff
  43 #define USART_BRGH_LOW    0xef
  44 #define USART_CONT_RX     0xff
  45 #define USART_SINGLE_RX   0xf7
  46 #define USART_SYNC_MASTER 0xff
  47 #define USART_SYNC_SLAVE  0xfb
  48 #define USART_NINE_BIT    0xff
  49 #define USART_EIGHT_BIT   0xfd
  50 #define USART_SYNCH_MODE  0xff
  51 #define USART_ASYNCH_MODE 0xfe
  52
  53 /*
  54  * USART styles:
  55  *
  56  * --- Families with 1 USART ---
  57  *
  58  * INIT:
  59  *      RCSTA<7> = 1    (SPEN)
  60  *      TXSTA<4> = 0    (SYNC)
  61  *      TXSTA<5> = 1    (TXEN)
  62  *
  63  * 18f1220:
  64  *      RB1/AN5/TX and RB4/AN6/RX
  65  *
  66  *      TRISB<1> = TRISB<4> = 1 (TX, RX)
  67  *      ADCON1<5> = ADCON1<6> = 1 (PCFG<5>, PCFG<6>)
  68  *      SPBRGH:SPBRG
  69  *
  70  * 18f13k50:
  71  *      RB7/TX and RB5/AN11/RX
  72  *
  73  *      TRISB<7> = TRISB<5> = 1 (TX, RX)
  74  *      ANSELH<3> = 0 (ANS11/RX)
  75  *      SPBRGH:SPBRG
  76  *
  77  * 18f2220:
  78  *      RC6/TX and RC7/RX
  79  *
  80  *      TRISC<6> = 0    (TX)
  81  *      TRISC<7> = 1    (RX)
  82  *      SPBRG
  83  *
  84  * 18f2221/18f2331/18f23k20/18f2410/18f2420/18f2423/18f2455/18f24j10/18f2525:
  85  *      RC6/TX and RC7/RX
  86  *
  87  *      TRISC<6> = TRISC<7> = 1 (TX, RX)
  88  *      SPBRGH:SPBRG
  89  *
  90  * 18f2450/18f2480/18f2585/18f2682/18f6585/18f6680/18f8585/18f8680:
  91  *      RC6/TX and RC7/RX
  92  *
  93  *      TRISC<6> = 0    (TX)
  94  *      TRISC<7> = 1    (RX)
  95  *      SPBRGH:SPBRG
  96  *
  97  * --- Families with 2+ USARTs ---
  98  *
  99  * INIT:
 100  *      RCSTA1<7> = 1   (SPEN)
 101  *      TXSTA1<4> = 0   (SYNC)
 102  *      TXSTA1<5> = 1   (TXEN)
 103  *
 104  * 18f24j50/18f6527/18f65j50/18f66j60:
 105  *      RC6/TX1 and RC7/RX1 (EUSART1)
 106  *
 107  *      TRISC<6> = 0    (TX1)
 108  *      TRISC<7> = 1    (RX1)
 109  *      SPBRGH1:SPBRG1
 110  *
 111  * 18f6520:
 112  *      RC6/TX1 and RC7/RX1 (EUSART1)
 113  *
 114  *      TRISC<6> = 0    (TX1)
 115  *      TRISC<7> = 1    (RX1)
 116  *      SPBRG1
 117  *
 118  */
 119 #include "pic18fam.h"
 120
 121 #if (__SDCC_USART_STYLE == 0)
 122 #warning The target device is not supported by the SDCC PIC16 USART library.
 123 #endif
 124
 125 #if (__SDCC_USART_STYLE == 1822200) || \
 126     (__SDCC_USART_STYLE == 1865200)
 127 #define __SDCC_NO_SPBRGH        1
 128 #endif  /* device lacks SPBRGH */
 129
 130
 131 #if __SDCC_NO_SPBRGH
 132 typedef unsigned char sdcc_spbrg_t;
 133 #else   /* !__SDCC_NO_SPBRGH */
 134 typedef unsigned int sdcc_spbrg_t;
 135 #endif  /* !__SDCC_NO_SPBRGH */
 136
 137
 138 /* status bits */
 139 union USART
 140 {
 141   unsigned char val;
 142   struct
 143   {
 144     unsigned RX_NINE:1;
 145     unsigned TX_NINE:1;
 146     unsigned FRAME_ERROR:1;
 147     unsigned OVERRUN_ERROR:1;
 148     unsigned fill:4;
 149   };
 150 };
 151
 152 void usart_open (unsigned char config, sdcc_spbrg_t spbrg) __wparam;
 153 void usart_close (void);
 154
 155 unsigned char usart_busy (void) __naked;
 156 unsigned char usart_drdy (void) __naked;
 157
 158 unsigned char usart_getc (void);
 159 void usart_gets (RAM_SCLS char * buffer, unsigned char len);
 160
 161 void usart_putc (unsigned char data) __wparam __naked;
 162 void usart_puts (char * data);
 163
 164
 165 void usart_baud (sdcc_spbrg_t baudconfig) __wparam;
 166
 167 #endif