56b7730773
The new vendor event provides a mechanism to deliver auxiliary data, which is automatically retrieved during the data transfer, but not accessible through the library interface otherwise. Possible examples include handshake data and/or device identification data. This event is mainly intended for diagnostic purposes, in combination with the memory dumping support. Very few applications will actually need it for anything else.
109 lines
3.1 KiB
C
109 lines
3.1 KiB
C
/*
|
|
* libdivecomputer
|
|
*
|
|
* Copyright (C) 2008 Jef Driesen
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef DC_DEVICE_H
|
|
#define DC_DEVICE_H
|
|
|
|
#include "common.h"
|
|
#include "context.h"
|
|
#include "descriptor.h"
|
|
#include "buffer.h"
|
|
#include "datetime.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef enum dc_event_type_t {
|
|
DC_EVENT_WAITING = (1 << 0),
|
|
DC_EVENT_PROGRESS = (1 << 1),
|
|
DC_EVENT_DEVINFO = (1 << 2),
|
|
DC_EVENT_CLOCK = (1 << 3),
|
|
DC_EVENT_VENDOR = (1 << 4)
|
|
} dc_event_type_t;
|
|
|
|
typedef struct dc_device_t dc_device_t;
|
|
|
|
typedef struct dc_event_progress_t {
|
|
unsigned int current;
|
|
unsigned int maximum;
|
|
} dc_event_progress_t;
|
|
|
|
typedef struct dc_event_devinfo_t {
|
|
unsigned int model;
|
|
unsigned int firmware;
|
|
unsigned int serial;
|
|
} dc_event_devinfo_t;
|
|
|
|
typedef struct dc_event_clock_t {
|
|
unsigned int devtime;
|
|
dc_ticks_t systime;
|
|
} dc_event_clock_t;
|
|
|
|
typedef struct dc_event_vendor_t {
|
|
const unsigned char *data;
|
|
unsigned int size;
|
|
} dc_event_vendor_t;
|
|
|
|
typedef int (*dc_cancel_callback_t) (void *userdata);
|
|
|
|
typedef void (*dc_event_callback_t) (dc_device_t *device, dc_event_type_t event, const void *data, void *userdata);
|
|
|
|
typedef int (*dc_dive_callback_t) (const unsigned char *data, unsigned int size, const unsigned char *fingerprint, unsigned int fsize, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_device_open (dc_device_t **out, dc_context_t *context, dc_descriptor_t *descriptor, const char *name);
|
|
|
|
dc_family_t
|
|
dc_device_get_type (dc_device_t *device);
|
|
|
|
dc_status_t
|
|
dc_device_set_cancel (dc_device_t *device, dc_cancel_callback_t callback, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_device_set_events (dc_device_t *device, unsigned int events, dc_event_callback_t callback, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_device_set_fingerprint (dc_device_t *device, const unsigned char data[], unsigned int size);
|
|
|
|
dc_status_t
|
|
dc_device_version (dc_device_t *device, unsigned char data[], unsigned int size);
|
|
|
|
dc_status_t
|
|
dc_device_read (dc_device_t *device, unsigned int address, unsigned char data[], unsigned int size);
|
|
|
|
dc_status_t
|
|
dc_device_write (dc_device_t *device, unsigned int address, const unsigned char data[], unsigned int size);
|
|
|
|
dc_status_t
|
|
dc_device_dump (dc_device_t *device, dc_buffer_t *buffer);
|
|
|
|
dc_status_t
|
|
dc_device_foreach (dc_device_t *device, dc_dive_callback_t callback, void *userdata);
|
|
|
|
dc_status_t
|
|
dc_device_close (dc_device_t *device);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif /* DC_DEVICE_H */
|