summaryrefslogtreecommitdiff
path: root/include/uhd/dev.h
blob: 21775dbd5cb8947b9cf62e22261160eaa5ac44f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/** @file
 * @brief usbhid-dump - device
 *
 * Copyright (C) 2010 Nikolai Kondrashov
 *
 * This file is part of usbhid-dump.
 *
 * Usbhid-dump is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Usbhid-dump 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with usbhid-dump; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @author Nikolai Kondrashov <spbnick@gmail.com>
 *
 * @(#) $Id$
 */

#ifndef __UHD_DEV_H__
#define __UHD_DEV_H__

#include <stdbool.h>
#include <libusb-1.0/libusb.h>

#ifdef __cplusplus
extern "C" {
#endif

/** usbhid-dump device */
typedef struct uhd_dev uhd_dev;

struct uhd_dev {
    uhd_dev                *next;       /**< Next device in the list */
    libusb_device_handle   *handle;     /**< Handle */
};

/**
 * Check if a device is valid.
 *
 * @param dev Device to check.
 *
 * @return True if the device is valid, false otherwise.
 */
extern bool uhd_dev_valid(const uhd_dev *dev);

/**
 * Open a device.
 *
 * @param lusb_dev  Libusb device.
 * @param pdev      Location for the opened device pointer.
 *
 * @return Libusb error code.
 */
extern enum libusb_error uhd_dev_open(libusb_device    *lusb_dev,
                                      uhd_dev         **pdev);

/**
 * Close a device.
 *
 * @param dev   The device to close.
 */
extern void uhd_dev_close(uhd_dev *dev);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* __UHD_DEV_H__ */