serial.h

Go to the documentation of this file.

/*
 * serial.h
 *
 * Copyright (c) 2012, Thomas Buck <xythobuz@me.com>
 * 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.
 *
 * 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 _serial_h
#define _serial_h

#define BAUD(baudRate,xtalCpu) ((xtalCpu)/((baudRate)*16l)-1)

uint8_t serialAvailable(void);

void serialInit(uint8_t uart, uint16_t baud);

void serialClose(uint8_t uart);

void setFlow(uint8_t uart, uint8_t on);

uint8_t serialHasChar(uint8_t uart);

uint8_t serialGet(uint8_t uart);

uint8_t serialGetBlocking(uint8_t uart);

uint8_t serialRxBufferFull(uint8_t uart);

uint8_t serialRxBufferEmpty(uint8_t uart);

void serialWrite(uint8_t uart, uint8_t data);

void serialWriteString(uint8_t uart, const char *data);

uint8_t serialTxBufferFull(uint8_t uart);

uint8_t serialTxBufferEmpty(uint8_t uart);

#endif // _serial_h