console.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the software nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BSP430_UTILITY_CONSOLE_H
#define BSP430_UTILITY_CONSOLE_H

#include <bsp430/serial.h>
#include <stdarg.h>

#ifndef configBSP430_CONSOLE
#define configBSP430_CONSOLE 0
#endif /* configBSP430_CONSOLE */

#if defined(BSP430_DOXYGEN)
#define BSP430_CONSOLE include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN)
#define BSP430_CONSOLE_SERIAL_PERIPH_CPPID include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN)
#define BSP430_CONSOLE_SERIAL_PERIPH_HANDLE include <bsp430/platform.h>
#endif /* BSP430_CONSOLE_SERIAL_PERIPH_HANDLE */

#ifndef BSP430_CONSOLE_BAUD_RATE
#define BSP430_CONSOLE_BAUD_RATE 9600
#endif /* BSP430_CONSOLE_BAUD_RATE */

#ifndef BSP430_CONSOLE_RX_BUFFER_SIZE
#define BSP430_CONSOLE_RX_BUFFER_SIZE 0
#endif /* BSP430_CONSOLE_RX_BUFFER_SIZE */

#ifndef BSP430_CONSOLE_TX_BUFFER_SIZE
#define BSP430_CONSOLE_TX_BUFFER_SIZE 0
#endif /* BSP430_CONSOLE_TX_BUFFER_SIZE */

#ifndef BSP430_CONSOLE_USE_EMBTEXTF
#define BSP430_CONSOLE_USE_EMBTEXTF 0
#endif /* BSP430_CONSOLE_USE_EMBTEXTF */

int cgetchar (void);


#if defined(BSP430_DOXYGEN) || (0 < BSP430_CONSOLE_RX_BUFFER_SIZE)

typedef int (* iBSP430consoleRxCallback_ni) (void);

int cpeekchar (void);

void vBSP430consoleSetRxCallback_ni (iBSP430consoleRxCallback_ni cb);

#endif /* BSP430_CONSOLE_RX_BUFFER_SIZE */

#ifndef configBSP430_CONSOLE_PROVIDES_PUTCHAR
#define configBSP430_CONSOLE_PROVIDES_PUTCHAR 1
#endif /* configBSP430_CONSOLE_PROVIDES_PUTCHAR */

#ifndef configBSP430_CONSOLE_PROVIDES_STDIO
#define configBSP430_CONSOLE_PROVIDES_STDIO (BSP430_CORE_TOOLCHAIN_LIBC_NEWLIB - 0)
#endif /* configBSP430_CONSOLE_PROVIDES_STDIO */

#ifndef configBSP430_CONSOLE_USE_ONLCR
#define configBSP430_CONSOLE_USE_ONLCR 1
#endif /* configBSP430_CONSOLE_USE_ONLCR */

int cputs (const char * s);

int cputchar (int c);

int cputtext (const char * s);

int cputchars (const char * cp, size_t len);

#if (defined(BSP430_DOXYGEN)                            \
     || (BSP430_CONSOLE_USE_EMBTEXTF - 0)               \
     || (BSP430_CORE_TOOLCHAIN_LIBC_MSP430_LIBC - 0)    \
     || (BSP430_CORE_TOOLCHAIN_LIBC_NEWLIB - 0))

int cprintf (const char * format, ...)
#if (__GNUC__ - 0)
__attribute__((__format__(printf, 1, 2)))
#endif /* __GNUC__ */
;

int vcprintf (const char * format, va_list ap);

int cputi (int n, int radix);

int cputu (unsigned int n, int radix);

int cputl (long n, int radix);

int cputul (unsigned long n, int radix);

#endif /* BSP430_CONSOLE_USE_EMBTEXTF */

int iBSP430consoleInitialize (void);

int iBSP430consoleDeconfigure (void);

hBSP430halSERIAL hBSP430console (void);

int iBSP430consoleTransmitUseInterrupts_ni (int enablep);

int iBSP430consoleWaitForTxSpace_ni (int want_available);

int iBSP430consoleFlush (void);

void vBSP430consoleDisplayMemory (const uint8_t * dp,
                                  size_t len,
                                  unsigned long base);

void vBSP430consoleDisplayOctets (const uint8_t * dp,
                                  size_t len);

#endif /* BSP430_UTILITY_CONSOLE_H */