clean up some comments

[proxmark3-svn] / common / cmd.c

/*\r
 * Proxmark send and receive commands\r
 *\r
 * Copyright (c) 2012, Roel Verdult\r
 * All rights reserved.\r
 *\r
 * Redistribution and use in source and binary forms, with or without\r
 * modification, are permitted provided that the following conditions are met:\r
 * 1. Redistributions of source code must retain the above copyright\r
 * notice, this list of conditions and the following disclaimer.\r
 * 2. Redistributions in binary form must reproduce the above copyright\r
 * notice, this list of conditions and the following disclaimer in the\r
 * documentation and/or other materials provided with the distribution.\r
 * 3. Neither the name of the copyright holders nor the\r
 * names of its contributors may be used to endorse or promote products\r
 * derived from this software without specific prior written permission.\r
 *\r
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY\r
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY\r
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\r
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
 *\r
 * @file cmd.c\r
 * @brief\r
 */\r
\r
#include "cmd.h"\r
#include "string.h"\r
#include "proxmark3.h"\r
\r
bool cmd_receive(UsbCommand* cmd) {\r
 \r
  // Check if there is a usb packet available\r
  if (!usb_poll()) return false;\r
  \r
  // Try to retrieve the available command frame\r
  size_t rxlen = usb_read((byte_t*)cmd,sizeof(UsbCommand));\r
\r
  // Check if the transfer was complete\r
  if (rxlen != sizeof(UsbCommand)) return false;\r
  \r
  // Received command successfully\r
  return true;\r
}\r
\r
bool cmd_send(uint32_t cmd, uint32_t arg0, uint32_t arg1, uint32_t arg2, void* data, size_t len) {\r
  UsbCommand txcmd;\r
\r
  for (size_t i=0; i<sizeof(UsbCommand); i++) {\r
    ((byte_t*)&txcmd)[i] = 0x00;\r
  }\r
  \r
  // Compose the outgoing command frame\r
  txcmd.cmd = cmd;\r
  txcmd.arg[0] = arg0;\r
  txcmd.arg[1] = arg1;	\r
  txcmd.arg[2] = arg2;\r
\r
  // Add the (optional) content to the frame, with a maximum size of USB_CMD_DATA_SIZE\r
  if (data && len) {\r
    len = MIN(len,USB_CMD_DATA_SIZE);\r
    for (size_t i=0; i<len; i++) {\r
      txcmd.d.asBytes[i] = ((byte_t*)data)[i];\r
    }\r
  }\r
  \r
  // Send frame and make sure all bytes are transmitted\r
  if (usb_write((byte_t*)&txcmd,sizeof(UsbCommand)) != 0) return false;\r
  \r
  return true;\r
}\r
\r
\r