uart-exchange.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, Cascoda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDERS 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 UART_EXCHANGE_H
#define UART_EXCHANGE_H
 
#include "ca821x-posix/ca821x-types.h"
#include "ca821x_api.h"
#define TEST_ENABLE 1
 
enum uart_exchange_errors
{
    uart_exchange_err_uart = 1, //uart error - probably device removed and going to have to crash safely
    uart_exchange_err_ca821x,   //ca821x error - ca821x has been reset
    uart_exchange_err_generic
};
 
#ifdef _WIN32
ca_error uart_exchange_init(ca821x_errorhandler              callback,
                            struct ca821x_dev               *pDeviceRef,
                            union ca821x_util_init_extra_arg arg);
#else
ca_error uart_exchange_init(ca821x_errorhandler callback, const char *path, struct ca821x_dev *pDeviceRef);
#endif
 
void uart_exchange_deinit(struct ca821x_dev *pDeviceRef);
 
ca_error uart_exchange_enumerate(util_device_found aCallback, void *aContext);
 
int uart_exchange_reset(unsigned long resettime, struct ca821x_dev *pDeviceRef);
 
#endif