usb_linux_utils.h

Go to the documentation of this file.

/*
 * BSD 3-Clause License
 *
 * Copyright (c) 2019, Analog Devices, Inc.
 * 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 HOLDER 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 USB_LINUX_UTILS_H
#define USB_LINUX_UTILS_H
 
#include <aditof/status_definitions.h>
#include <cstdint>
#include <string>
 
#define CLEAR(x) memset(&(x), 0, sizeof(x))
 
#define MAX_PACKET_SIZE (58)
#define MAX_BUF_SIZE (MAX_PACKET_SIZE + 2)
 
class UsbLinuxUtils {
  public:
    static int xioctl(int fh, unsigned long request, void *arg);
 
    static int uvcExUnitReadOnePacket(int fd, uint8_t selector,
                                      uint8_t *BytesToWrite,
                                      uint8_t nbBytesToWrite, uint8_t *data,
                                      uint8_t nbPacketBytes,
                                      uint8_t nbBytesToRead);
 
    static int uvcExUnitReadBuffer(int fd, uint8_t selector, int16_t id,
                                   uint32_t address, uint8_t *data,
                                   uint32_t bufferLength);
 
    static int uvcExUnitWriteBuffer(int fd, uint8_t selector, int16_t id,
                                    uint32_t address, const uint8_t *data,
                                    uint32_t bufferLength);
    static aditof::Status uvcExUnitGetString(int fd, int uvcControlId,
                                             std::string &outStr);
 
    static int UvcExUnitSetProperty(int fd, uint8_t selector,
                                    const uint8_t *data, size_t nbBytes);
 
    static int UvcExUnitGetProperty(int fd, uint8_t selector, uint8_t *data,
                                    size_t nbBytes);
 
    static aditof::Status uvcExUnitSendRequest(int fd,
                                               const std::string &requestStr);
 
    static aditof::Status uvcExUnitGetResponse(int fd,
                                               std::string &responseStr);
};
 
#endif // USB_LINUX_UTILS_H