ca821x-posix-evbme.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, 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 POSIX_CA821X_POSIX_INCLUDE_CA821X_POSIX_CA821X_POSIX_EVBME_H_
#define POSIX_CA821X_POSIX_INCLUDE_CA821X_POSIX_CA821X_POSIX_EVBME_H_
 
#include "ca821x_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
//Callback definitions ------------------------------------------------------------------------
 
typedef ca_error (*EVBME_Message_callback)(struct EVBME_Message *params, struct ca821x_dev *pDeviceRef);
 
struct EVBME_callbacks
{
    EVBME_Message_callback EVBME_MESSAGE_indication;
    EVBME_Message_callback EVBME_COMM_indication;
    EVBME_Message_callback EVBME_DFU_cmd;
};
 
//Structure to store version numbers in a convenient format
struct ca_version_number
{
    int major_version;
    int minor_version;
};
 
struct EVBME_callbacks *EVBME_GetCallbackStruct(struct ca821x_dev *pDeviceRef);
 
//Asynchronous commands -----------------------------------------------------------------------
 
ca_error EVBME_COMM_CHECK_request(uint8_t            aHandle,
                                  uint8_t            aDelay,
                                  uint8_t            aIndCount,
                                  uint8_t            aIndSize,
                                  uint8_t            aPayloadLen,
                                  struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_HOST_CONNECTED_notify(struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_HOST_DISCONNECTED_notify(struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_DFU_REBOOT_request(enum evbme_dfu_rebootmode aRebootMode, struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_DFU_ERASE_request(uint32_t aStartAddr, uint32_t aEraseLen, struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_DFU_WRITE_request(uint32_t           aStartAddr,
                                 size_t             aWriteLen,
                                 void              *aWriteData,
                                 struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_DFU_CHECK_request(uint32_t           aStartAddr,
                                 uint32_t           aCheckLen,
                                 uint32_t           aChecksum,
                                 struct ca821x_dev *pDeviceRef);
 
ca_error EVBME_DFU_BOOTMODE_request(enum evbme_dfu_rebootmode aBootMode, struct ca821x_dev *pDeviceRef);
 
//Synchronous commands -----------------------------------------------------------------------
 
ca_error EVBME_SET_request_sync(enum evbme_attribute aAttrId,
                                size_t               aAttrLen,
                                uint8_t             *aAttrData,
                                struct ca821x_dev   *pDeviceRef);
 
ca_error EVBME_GET_request_sync(enum evbme_attribute aAttrId,
                                size_t               aMaxAttrLen,
                                uint8_t             *aAttrData,
                                uint8_t             *aAttrLen,
                                struct ca821x_dev   *pDeviceRef);
 
int EVBME_CompareVersions(const char               *aVersion1,
                          const char               *aVersion2,
                          struct ca_version_number *aVersion1Number,
                          struct ca_version_number *aVersion2Number);
 
ca_error EVBME_CheckVersion(const char *aMinVerString, struct ca821x_dev *pDeviceRef);
 
#ifdef __cplusplus
}
#endif
 
#endif /* POSIX_CA821X_POSIX_INCLUDE_CA821X_POSIX_CA821X_POSIX_EVBME_H_ */