ca821x-types.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_TYPES_H_
#define CA821X_TYPES_H_
 
#include <pthread.h>
#include <stdint.h>
#include <unistd.h>
 
#include "ca821x-posix/ca821x-posix-config.h"
#include "ca821x-posix/ca821x-posix-evbme.h"
#include "ca821x_api.h"
#include "ca821x_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef ca_error (*ca821x_errorhandler)(ca_error error, struct ca821x_dev *pDeviceRef);
 
typedef ca_error (*exchange_user_callback)(const uint8_t *buf, size_t len, struct ca821x_dev *pDeviceRef);
 
typedef ca_error (*exchange_write)(const uint8_t *buf, size_t len, struct ca821x_dev *pDeviceRef);
 
typedef ca_error (*exchange_write_isready)(struct ca821x_dev *pDeviceRef);
 
typedef ssize_t (*exchange_read)(struct ca821x_dev *pDeviceRef, uint8_t *buf);
 
typedef void (*exchange_signal_read)(struct ca821x_dev *pDeviceRef);
 
typedef void (*exchange_flush_unread)(struct ca821x_dev *pDeviceRef);
 
union ca821x_util_init_extra_arg
{
    char *generic;      
    char *serial_num;   
    char *com_port_num; 
    char *force;        
};
 
enum ca821x_exchange_type
{
    ca821x_exchange_kernel = 1, 
    ca821x_exchange_usb,        
    ca821x_exchange_uart,       
};
 
struct buffer_queue_item
{
    size_t                    len;        
    uint8_t                  *buf;        
    struct ca821x_dev        *pDeviceRef; 
    struct buffer_queue_item *next;       
};
 
struct buffer_queue
{
    struct buffer_queue_item *head;
    pthread_mutex_t           q_mutex;
    pthread_cond_t            q_cond;
};
 
struct ca821x_exchange_base
{
    enum ca821x_exchange_type exchange_type; 
 
    ca821x_errorhandler    error_callback;     
    exchange_user_callback user_callback;      
    exchange_write         write_func;         
    exchange_write_isready write_isready_func; 
    exchange_signal_read   signal_func;        
    exchange_read          read_func;          
    exchange_flush_unread  flush_func;         
 
    //Synchronous queue
    pthread_t       io_thread;         
    int             io_thread_runflag; 
    pthread_mutex_t flag_mutex;        
    pthread_cond_t  sync_cond;         
    pthread_mutex_t sync_mutex;        
 
    //In queue = Device to host(us)
    //Out queue = Host(us) to device
    struct buffer_queue in_buffer_queue, out_buffer_queue; 
 
    struct EVBME_callbacks evbme_callbacks; 
 
    int      flash_fd;     
    uint32_t base_address; 
    uint32_t used_size;    
};
 
struct ca_device_info
{
    enum ca821x_exchange_type exchange_type; 
    const char             *path;          
    const char             *device_name;   
    const char             *app_name;      
    const char             *version;       
    const char             *serialno;      
 
    bool external_flash_available; 
    bool available;                
};
 
typedef void (*util_device_found)(struct ca_device_info *aDeviceInfo, void *aContext);
 
#ifdef __cplusplus
}
#endif
 
#endif /* CA821X_TYPES_H_ */