PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
esos_pc_stdio.h
1 /*
2  * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
3  * All rights reserved.
4  * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
5  * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
6  * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation for any purpose, without fee, and without written agreement is
10  * hereby granted, provided that the above copyright notice, the following
11  * two paragraphs and the authors appear in all copies of this software.
12  *
13  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
15  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
16  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17  *
18  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
23  *
24  * Please maintain this header in its entirety when copying/modifying
25  * these files.
26  *
27  *
28  */
29 
30 #ifndef _ESOS_PC_STDIO_H
31 #define _ESOS_PC_STDIO_H
32 
33 /* I N C L U D E S **********************************************************/
34 #include "esos.h"
35 #include "esos_comm.h"
36 #include "esos_pc.h"
37 
38 /* D E F I N I T I O N S ****************************************************/
39 
40 /* E X T E R N S ************************************************************/
41 extern struct termios stored_settings;
42 
43 /* M A C R O S **************************************************************/
44 
45 /* P U B L I C P R O T O T Y P E S *****************************************/
46 void __esos_hw_signal_start_tx(void);
47 void __esos_hw_signal_stop_tx(void);
48 uint8_t kbhit(void);
49 void set_keypress(void);
50 
51 // Documentation for this file. If the \file tag isn't present,
52 // this file won't be documented.
53 /*
54  * This file contains routines which configure and
55  * use STDIO on the PC for communications.
56  */
57 
58 // communications commands used outside of ESOS tasks (like user_init routine)
59 // these routines/macros should almost never be used.
60 void __esos_hw_PutUint8(uint8_t u8_c);
61 void __esos_hw_PutString(uint8_t* psz_in);
62 uint8_t __esos_hw_GetUint8(void);
63 
64 void __esos_hw_InitCommSystem(void);
65 
66 #endif // end ESOS_PC_STDIO_H