pios_com.h

Go to the documentation of this file.

/* 
 * This program is free software; you can redistribute it and/or modify 
 * it under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; either version 3 of the License, or 
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License along 
 * with this program; if not, see <http://www.gnu.org/licenses/>
 */

#ifndef PIOS_COM_H
#define PIOS_COM_H

#include <stdint.h>             /* uint*_t */
#include <stdbool.h>            /* bool */

struct pios_com_driver;

struct pios_com_dev;

typedef uint16_t (*pios_com_callback)(uintptr_t context, uint8_t * buf, uint16_t buf_len, uint16_t * headroom, bool * task_woken);

struct pios_com_driver {
        void (*set_baud)(uintptr_t id, uint32_t baud);
        void (*tx_start)(uintptr_t id, uint16_t tx_bytes_avail);
        void (*rx_start)(uintptr_t id, uint16_t rx_bytes_avail);
        void (*bind_rx_cb)(uintptr_t id, pios_com_callback rx_in_cb, uintptr_t context);
        void (*bind_tx_cb)(uintptr_t id, pios_com_callback tx_out_cb, uintptr_t context);
        bool (*available)(uintptr_t id);
};

/* Public Functions */
extern uintptr_t PIOS_COM_GetDriverCtx(uintptr_t com_id);
extern int32_t PIOS_COM_ChangeBaud(uintptr_t com_id, uint32_t baud);
extern int32_t PIOS_COM_SendCharNonBlocking(uintptr_t com_id, char c);
extern int32_t PIOS_COM_SendChar(uintptr_t com_id, char c);
extern int32_t PIOS_COM_SendBufferNonBlocking(uintptr_t com_id, const uint8_t *buffer, uint16_t len);
extern int32_t PIOS_COM_SendBufferStallTimeout(uintptr_t com_id, const uint8_t *buffer, uint16_t len, uint32_t max_ms);
extern int32_t PIOS_COM_SendBuffer(uintptr_t com_id, const uint8_t *buffer, uint16_t len);
extern int32_t PIOS_COM_SendStringNonBlocking(uintptr_t com_id, const char *str);
extern int32_t PIOS_COM_SendString(uintptr_t com_id, const char *str);
extern int32_t PIOS_COM_SendFormattedStringNonBlocking(uintptr_t com_id, const char *format, ...);
extern int32_t PIOS_COM_SendFormattedString(uintptr_t com_id, const char *format, ...);
extern uint16_t PIOS_COM_ReceiveBuffer(uintptr_t com_id, uint8_t * buf, uint16_t buf_len, uint32_t timeout_ms);
extern bool PIOS_COM_Available(uintptr_t com_id);
uint16_t PIOS_COM_GetNumReceiveBytesPending(uintptr_t com_id);

#endif /* PIOS_COM_H */