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 <stdio.h>
  33 #include <libusb.h>
  34 #include "libsigrok.h"
  35 #include "libsigrok-internal.h"
  36 #include "gl_usb.h"
  37 #include "protocol.h"
  38
  39 #define CTRL_IN         (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN | \
  40                          LIBUSB_RECIPIENT_INTERFACE)
  41 #define CTRL_OUT        (LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT | \
  42                          LIBUSB_RECIPIENT_INTERFACE)
  43 #define EP1_BULK_IN     (LIBUSB_ENDPOINT_IN | 1)
  44
  45 #define TIMEOUT_MS      (5 * 1000)
  46
  47 enum {
  48         REQ_READBULK = 0x82,
  49         REQ_WRITEADDR,
  50         REQ_READDATA,
  51         REQ_WRITEDATA,
  52 };
  53
  54 static int gl_write_address(libusb_device_handle *devh, unsigned int address)
  55 {
  56         unsigned char packet[8] = { address & 0xFF };
  57         int ret;
  58
  59         ret = libusb_control_transfer(devh, CTRL_OUT, 0xc, REQ_WRITEADDR,
  60                                          0, packet, 1, TIMEOUT_MS);
  61         if (ret != 1)
  62                 sr_err("%s: %s.", __func__, libusb_error_name(ret));
  63         return ret;
  64 }
  65
  66 static int gl_write_data(libusb_device_handle *devh, unsigned int val)
  67 {
  68         unsigned char packet[8] = { val & 0xFF };
  69         int ret;
  70
  71         ret = libusb_control_transfer(devh, CTRL_OUT, 0xc, REQ_WRITEDATA,
  72                                       0, packet, 1, TIMEOUT_MS);
  73         if (ret != 1)
  74                 sr_err("%s: %s.", __func__, libusb_error_name(ret));
  75         return ret;
  76 }
  77
  78 static int gl_read_data(libusb_device_handle *devh)
  79 {
  80         unsigned char packet[8] = { 0 };
  81         int ret;
  82
  83         ret = libusb_control_transfer(devh, CTRL_IN, 0xc, REQ_READDATA,
  84                                       0, packet, 1, TIMEOUT_MS);
  85         if (ret != 1)
  86                 sr_err("%s: %s, val=%hhx.", __func__,
  87                        libusb_error_name(ret), packet[0]);
  88         return (ret == 1) ? packet[0] : ret;
  89 }
  90
  91 SR_PRIV int gl_read_bulk(libusb_device_handle *devh, void *buffer,
  92                          unsigned int size)
  93 {
  94         unsigned char packet[8] =
  95             { 0, 0, 0, 0, size & 0xff, (size & 0xff00) >> 8,
  96               (size & 0xff0000) >> 16, (size & 0xff000000) >> 24 };
  97         int ret, transferred = 0;
  98
  99         ret = libusb_control_transfer(devh, CTRL_OUT, 0x4, REQ_READBULK,
 100                                       0, packet, 8, TIMEOUT_MS);
 101         if (ret != 8)
 102                 sr_err("%s: libusb_control_transfer: %s.", __func__,
 103                        libusb_error_name(ret));
 104
 105         ret = libusb_bulk_transfer(devh, EP1_BULK_IN, buffer, size,
 106                                    &transferred, TIMEOUT_MS);
 107         if (ret < 0)
 108                 sr_err("%s: libusb_bulk_transfer: %s.", __func__,
 109                        libusb_error_name(ret));
 110         return transferred;
 111 }
 112
 113 SR_PRIV int gl_reg_write(libusb_device_handle *devh, unsigned int reg,
 114                  unsigned int val)
 115 {
 116         int ret;
 117
 118         ret = gl_write_address(devh, reg);
 119         if (ret < 0)
 120                 return ret;
 121         ret = gl_write_data(devh, val);
 122         return ret;
 123 }
 124
 125 SR_PRIV int gl_reg_read(libusb_device_handle *devh, unsigned int reg)
 126 {
 127         int ret;
 128
 129         ret = gl_write_address(devh, reg);
 130         if (ret < 0)
 131                 return ret;
 132         ret = gl_read_data(devh);
 133         return ret;
 134 }
 135
 136 SR_PRIV int gl_reg_read_buf(libusb_device_handle *devh, unsigned int reg,
 137                 unsigned char *buf, unsigned int len)
 138 {
 139         int ret;
 140         unsigned int i;
 141
 142         ret = gl_write_address(devh, reg);
 143         if (ret < 0)
 144                 return ret;
 145         for (i = 0; i < len; i++) {
 146                 ret = gl_read_data(devh);
 147                 if (ret < 0)
 148                         return ret;
 149                 buf[i] = ret;
 150         }
 151         return 0;
 152 }