src/hardware/zeroplus-logic-cube/gl_usb.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010 Sven Peter <sven@fail0verflow.com>
   5  * Copyright (C) 2010 Haxx Enterprises <bushing@gmail.com>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or
   9  * without modification, are permitted provided that the following
  10  * conditions are met:
  11  *
  12  * * Redistributions of source code must retain the above copyright notice,
  13  *   this list of conditions and the following disclaimer.
  14  *
  15  * * Redistributions in binary form must reproduce the above copyright notice,
  16  *   this list of conditions and the following disclaimer in the documentation
  17  *   and/or other materials provided with the distribution.
  18  *
  19  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  23  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29  *  THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #include <config.h>
  33 #include <stdio.h>
  34 #include <libusb.h>
  35 #include <libsigrok/libsigrok.h>
  36 #include "libsigrok-internal.h"
  37 #include "gl_usb.h"
  38 #include "protocol.h"
  39
  40 #define CTRL_IN         (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN | \
  41                          LIBUSB_RECIPIENT_INTERFACE)
  42 #define CTRL_OUT        (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT | \
  43                          LIBUSB_RECIPIENT_INTERFACE)
  44 #define EP1_BULK_IN     (LIBUSB_ENDPOINT_IN | 1)
  45
  46 #define TIMEOUT_MS      (5 * 1000)
  47
  48 enum {
  49         REQ_READBULK = 0x82,
  50         REQ_WRITEADDR,
  51         REQ_READDATA,
  52         REQ_WRITEDATA,
  53 };
  54
  55 static int gl_write_address(libusb_device_handle *devh, unsigned int address)
  56 {
  57         unsigned char packet[8] = { address & 0xFF };
  58         int ret;
  59
  60         ret = libusb_control_transfer(devh, CTRL_OUT, 0xc, REQ_WRITEADDR,
  61                                          0, packet, 1, TIMEOUT_MS);
  62         if (ret != 1)
  63                 sr_err("%s: %s.", __func__, libusb_error_name(ret));
  64         return ret;
  65 }
  66
  67 static int gl_write_data(libusb_device_handle *devh, unsigned int val)
  68 {
  69         unsigned char packet[8] = { val & 0xFF };
  70         int ret;
  71
  72         ret = libusb_control_transfer(devh, CTRL_OUT, 0xc, REQ_WRITEDATA,
  73                                       0, packet, 1, TIMEOUT_MS);
  74         if (ret != 1)
  75                 sr_err("%s: %s.", __func__, libusb_error_name(ret));
  76         return ret;
  77 }
  78
  79 static int gl_read_data(libusb_device_handle *devh)
  80 {
  81         unsigned char packet[8] = { 0 };
  82         int ret;
  83
  84         ret = libusb_control_transfer(devh, CTRL_IN, 0xc, REQ_READDATA,
  85                                       0, packet, 1, TIMEOUT_MS);
  86         if (ret != 1)
  87                 sr_err("%s: %s, val=%hhx.", __func__,
  88                        libusb_error_name(ret), packet[0]);
  89         return (ret == 1) ? packet[0] : ret;
  90 }
  91
  92 SR_PRIV int gl_read_bulk(libusb_device_handle *devh, void *buffer,
  93                          unsigned int size)
  94 {
  95         unsigned char packet[8] = {
  96                 0, 0, 0, 0, size & 0xff, (size & 0xff00) >> 8,
  97                 (size & 0xff0000) >> 16, (size & 0xff000000) >> 24
  98         };
  99         int ret, transferred = 0;
 100
 101         ret = libusb_control_transfer(devh, CTRL_OUT, 0x4, REQ_READBULK,
 102                                       0, packet, 8, TIMEOUT_MS);
 103         if (ret != 8)
 104                 sr_err("%s: libusb_control_transfer: %s.", __func__,
 105                        libusb_error_name(ret));
 106
 107         ret = libusb_bulk_transfer(devh, EP1_BULK_IN, buffer, size,
 108                                    &transferred, TIMEOUT_MS);
 109         if (ret < 0)
 110                 sr_err("%s: libusb_bulk_transfer: %s.", __func__,
 111                        libusb_error_name(ret));
 112         return transferred;
 113 }
 114
 115 SR_PRIV int gl_reg_write(libusb_device_handle *devh, unsigned int reg,
 116                  unsigned int val)
 117 {
 118         int ret;
 119
 120         ret = gl_write_address(devh, reg);
 121         if (ret < 0)
 122                 return ret;
 123         ret = gl_write_data(devh, val);
 124         return ret;
 125 }
 126
 127 SR_PRIV int gl_reg_read(libusb_device_handle *devh, unsigned int reg)
 128 {
 129         int ret;
 130
 131         ret = gl_write_address(devh, reg);
 132         if (ret < 0)
 133                 return ret;
 134         ret = gl_read_data(devh);
 135         return ret;
 136 }
 137
 138 SR_PRIV int gl_reg_read_buf(libusb_device_handle *devh, unsigned int reg,
 139                 unsigned char *buf, unsigned int len)
 140 {
 141         int ret;
 142         unsigned int i;
 143
 144         ret = gl_write_address(devh, reg);
 145         if (ret < 0)
 146                 return ret;
 147         for (i = 0; i < len; i++) {
 148                 ret = gl_read_data(devh);
 149                 if (ret < 0)
 150                         return ret;
 151                 buf[i] = ret;
 152         }
 153         return 0;
 154 }