forth/serial.h

   1 // interface to serial port
   2
   3 //      Copyright 2009 Christopher Hall <hsw@openmoko.com>
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are
   7 // met:
   8 //
   9 //  1. Redistributions of source code must retain the above copyright
  10 //     notice, this list of conditions and the following disclaimer.
  11 //
  12 //  2. Redistributions in binary form must reproduce the above copyright
  13 //     notice, this list of conditions and the following disclaimer in
  14 //     the documentation and/or other materials provided with the
  15 //     distribution.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY
  18 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE
  21 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  24 // BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  26 // OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 #if !defined(_SERIAL_H_)
  30 #define _SERIAL_H_ 1
  31
  32 #include <stdbool.h>
  33
  34 void Serial_PutString(const char *string);
  35 void Serial_PutSpace(void);
  36 void Serial_PutCRLF(void);
  37 void Serial_PutChar(unsigned char c);
  38 void Serial_PutHex(unsigned long int value);
  39
  40 unsigned char Serial_GetChar(void);
  41 bool Serial_InputAvailable(void);
  42
  43 #endif