ca821x-posix.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2020, Cascoda Ltd.
 *  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 CA821X_POSIX_H
#define CA821X_POSIX_H 1
 
#include "ca821x-posix/ca821x-types.h"
#include "ca821x_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
ca_error ca821x_util_init(struct ca821x_dev               *pDeviceRef,
                          ca821x_errorhandler              errorHandler,
                          union ca821x_util_init_extra_arg arg);
 
ca_error ca821x_util_init_path(struct ca821x_dev        *pDeviceRef,
                               ca821x_errorhandler       errorHandler,
                               enum ca821x_exchange_type exchangeType,
                               const char               *path);
 
void ca821x_util_deinit(struct ca821x_dev *pDeviceRef);
 
ca_error ca821x_util_enumerate(util_device_found aCallback, bool enumerate_uart, void *aContext);
 
ca_error ca821x_util_reset(struct ca821x_dev *pDeviceRef);
 
ca_error ca821x_util_dispatch_poll();
 
ca_error ca821x_util_start_upstream_dispatch_worker();
 
ca_error ca821x_util_stop_upstream_dispatch_worker();
 
ca_error exchange_register_user_callback(exchange_user_callback callback, struct ca821x_dev *pDeviceRef);
 
ca_error exchange_wait_send_complete(time_t timeout_s, struct ca821x_dev *pDeviceRef);
 
ca_error exchange_user_command(uint8_t cmdid, uint8_t cmdlen, uint8_t *payload, struct ca821x_dev *pDeviceRef);
 
#ifdef __cplusplus
}
#endif
 
#endif //CA821X_POSIX_H