annotate Output/uartOut/arm/uart_serial.h @ 341:66eccdd9ced5

Code cleanup - Changing header file ifndef define to pragma once's - Removed duplicate output_com.h's
author Jacob Alexander <haata@kiibohd.com>
date Sun, 14 Jun 2015 13:56:56 -0700
parents aeac00164f2e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
341
66eccdd9ced5 Code cleanup
Jacob Alexander <haata@kiibohd.com>
parents: 171
diff changeset
1 /* Copyright (C) 2014-2015 by Jacob Alexander
171
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
2 *
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
4 * of this software and associated documentation files (the "Software"), to deal
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
5 * in the Software without restriction, including without limitation the rights
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
7 * copies of the Software, and to permit persons to whom the Software is
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
8 * furnished to do so, subject to the following conditions:
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
9 *
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
10 * The above copyright notice and this permission notice shall be included in
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
11 * all copies or substantial portions of the Software.
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
12 *
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
19 * THE SOFTWARE.
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
20 */
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
21
341
66eccdd9ced5 Code cleanup
Jacob Alexander <haata@kiibohd.com>
parents: 171
diff changeset
22 #pragma once
171
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
23
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
24 #include <inttypes.h>
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
25
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
26 int uart_serial_getchar();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
27 int uart_serial_available();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
28 int uart_serial_putchar( uint8_t c );
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
29 int uart_serial_write( const void *buffer, uint32_t size );
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
30
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
31 void uart_serial_flush_input();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
32 void uart_serial_flush_output();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
33
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
34 void uart_serial_setup();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
35
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
36 void uart_device_reload();
aeac00164f2e Initial code for ARM UART output module (mainly for CLI)
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
37