rpp-test-sw/commands/cmd_spi.c

   1 /*
   2  * Copyright (C) 2012-2013 Czech Technical University in Prague
   3  *
   4  * Created on: 28.2.2013
   5  *
   6  * Authors:
   7  *     - Michal Horn
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * File : cmd_spi.c
  23  *
  24  * Abstract:
  25  *      Command for processing data from SPI and
  26  *      lowlevel command for sending data on SPI
  27  *
  28  */
  29
  30 #include "cmd_spi.h"
  31 #include "stdio.h"
  32
  33 #ifndef DOCGEN
  34
  35 #include "rpp/rpp.h"
  36 #include "cmdproc_utils.h"
  37 #include "drv/drv.h"
  38 #include <_isfuncdcl.h>
  39
  40 /**
  41  *  @brief      Translate SPI response according the command and peripheral type
  42  *
  43  * @param[in]   cmd_io  Pointer to IO stack
  44  * @param[in]   des             Pointer to command descriptor
  45  * @param[in]   param   Parameters of command
  46  * @return      0 when OK or error code
  47  */
  48 int cmd_do_spi_translate(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
  49 {
  50         char *p;
  51         int i;
  52         uint32_t ret;
  53         uint32_t values[MAX_PARAM_VALUES_NUM];
  54         uint32_t numFieldDesc;
  55         uint32_t numCmdDesc;
  56         uint32_t command;
  57         uint32_t response;
  58         spitr_reg_translate_table_t translatedData;
  59         char peripheralName[32];
  60         char spareParams;
  61
  62         p = param[1];
  63         if (sscanf(p, "%31s ", peripheralName) != 1)
  64                 return -CMDERR_BADPAR;
  65
  66         const spitr_cmd_map_t *cmdDesc = cmdDesc = get_spi_cmd_map(peripheralName, -1, &numCmdDesc);
  67         if (cmdDesc == NULL) return -CMDERR_BADREG;
  68
  69
  70         if (param[2] != NULL) {         // More parameters expected
  71                 p = param[2];
  72                 if (sscanf(p, "%x %x %1s", &values[0], &values[1], &spareParams) != 2)
  73                         return -CMDERR_BADPAR;
  74                 command = values[0];
  75                 response = values[1];
  76
  77                 const spitr_field_desc_t *fieldDescs = get_spi_field_desc(cmdDesc, numCmdDesc, command, &numFieldDesc);
  78                 if (fieldDescs == NULL)
  79                         return -CMDERR_BADPAR;
  80
  81                 ret = spitr_fill_tr_table(fieldDescs, numFieldDesc, response, &translatedData);
  82
  83                 for (i = 0; i < translatedData.num_rows; i++) {
  84                         rpp_sci_printf("%s: %x\r\n", translatedData.row[i].field_name, translatedData.row[i].value);
  85                 }
  86                 return cmd_opchar_replong(cmd_io, param, ret, 0, 10);
  87         }
  88         else
  89                 return -CMDERR_BADPAR;
  90 }
  91
  92
  93 /* SPI Master testing command */
  94 #define TEST_BUF 64
  95 uint8_t spi_test_buf_tx[TEST_BUF];
  96 uint8_t spi_test_buf_rx[TEST_BUF];
  97
  98 int spimst_print_rx(struct spi_drv *ifc, int status, int addr, uint8_t *buf)
  99 {
 100         int i;
 101
 102         if (status < 0) {
 103                 rpp_sci_printf("spirx failed: %d\n", status);
 104                 return -1;
 105         }
 106
 107         rpp_sci_printf("spirx:%#x(", addr);
 108         for (i = 0; i < status; i++) {
 109                 rpp_sci_printf("%#x", buf[i]);
 110                 if (i < status-1)
 111                         rpp_sci_printf(",");
 112         }
 113         rpp_sci_printf(")\n");
 114
 115         return 0;
 116 }
 117
 118
 119 /**
 120  *  @brief      Send SPI command on SPI and receive response
 121  *
 122  * @param[in]   cmd_io  Pointer to IO stack
 123  * @param[in]   des             Pointer to command descriptor
 124  * @param[in]   param   Parameters of command
 125  * @return      0 when OK or error code
 126  */
 127 int cmd_do_spimst(cmd_io_t *cmd_io, const struct cmd_des *des, char *param[])
 128 {
 129         spi_drv_t *ifc;
 130         int i;
 131         char *p;
 132         char *token;
 133         int ret;
 134         unsigned int addr;
 135         unsigned int rq_len;
 136         int spi;
 137         int values[MAX_PARAM_VALUES_NUM];
 138
 139         p = param[1];
 140         if (sscanf(p, "%d", &spi) != 1)
 141                 return -CMDERR_BADPAR;
 142         p = param[2];
 143         if (sscanf(p, " %d", &addr) != 1)
 144                 return -CMDERR_BADPAR;
 145         token = strtok(p, " ");
 146         token = strtok(NULL, " ");
 147         i = 0;
 148         while (i < MAX_PARAM_VALUES_NUM && token != NULL) {
 149                 if (sscanf(token, "%x", &values[i]) == EOF)
 150                         break;
 151                 token = strtok(NULL, " ");
 152                 spi_test_buf_tx[i] = (uint8_t)values[i];
 153                 i++;
 154         }
 155
 156
 157         ifc = spi_find_drv(NULL, spi);
 158         if (ifc == NULL)
 159                 return -CMDERR_NODEV;
 160
 161         if (!(ifc->flags & SPI_IFC_ON))
 162                 //if (spi_tms570_init(ifc) < 0)
 163                 return -CMDERR_BADCFG;
 164
 165         rq_len = i;
 166
 167         ret = spi_transfer(ifc, addr, rq_len, spi_test_buf_tx, spi_test_buf_rx);
 168         spimst_print_rx(ifc, ret, addr, spi_test_buf_rx);
 169         return 0;
 170 }
 171
 172 #endif  /* DOCGEN */
 173 /** Command descriptor for SPI response translation */
 174 cmd_des_t const cmd_des_spi_translate = {
 175         0, CDESM_OPCHR|CDESM_RW,
 176         "spitr*","Translate response from an SPI peripheral",
 177         "### Command syntax ###\n"
 178         "\n"
 179         "    spitr<NAME> <CMD> <RESP>\n"
 180         "where\n"
 181         "\n"
 182         "- `<NAME>` is a string specifying the name of the peripheral (one of DINSPI, LOUT, DAC12, DAC34, HBR, FRAY1 and FRAY2)\n"
 183         "- `<CMD>` is a hexadecimal number in range 0 - FFFFFFFF\n"
 184         "- `<RESP>` is a hexadecimal number in range 0 - FFFFFFFF\n"
 185         "\n"
 186         "### Description ###\n"
 187         "\n"
 188         "This command translates a response from SPI from many different\n"
 189         "peripherals into a human readable form. The SPI response is in the\n"
 190         "form of a hexadecimal number, which encodes the information. This\n"
 191         "commands takes this response, the command which produced this\n"
 192         "response, the name of the peripheral and translates the response into\n"
 193         "the attribute-value table.\n"
 194         "\n"
 195         "### Example ###\n"
 196         "    --> portvalDINSPI 7F 00 00\n"
 197         "    portvalDINSPI=AAC03F\n"
 198         "    --> spitrDINSPI 7F0000 3FC0AA\n"
 199         "    Thermal flag       : 0\n"
 200         "    INT flag   : 0\n"
 201         "    SP0  - DIN0        : 1\n"
 202         "    SP1  - DIN1        : 1\n"
 203         "    SP2  - DIN2        : 1\n"
 204         "    SP3  - DIN3        : 1\n"
 205         "    SP4  - DIN4        : 1\n"
 206         "    SP5  - DIN5        : 1\n"
 207         "    SP6  - DIN6        : 1\n"
 208         "    SP7  - DIN7        : 1\n"
 209         "    SG0  - DIN8        : 0\n"
 210         "    SG1  - DIN9        : 1\n"
 211         "    SG2  - DIN10       : 0\n"
 212         "    SG3  - DIN11       : 1\n"
 213         "    SG4  - DIN12       : 0\n"
 214         "    SG5  - DIN13       : 1\n"
 215         "    SG6  - DIN14       : 0\n"
 216         "    SG7  - DIN15       : 1\n"
 217         "    SG8  - NA  : 0\n"
 218         "    SG9  - NA  : 0\n"
 219         "    SG10 - NA  : 0\n"
 220         "    SG11 - NA  : 0\n"
 221         "    SG12 - NA  : 0\n"
 222         "    SG13 - NA  : 0\n"
 223         "    spitrDINSPI=24\n"
 224         "\n"
 225         "Translates response 0x3FC0AA returned by command 0x7F0000 into a human\n"
 226         "readable form.\n"
 227         "Please notice LSB->MSB conversion of the portval result. The necessity\n"
 228         "of the conversion depends on the controller of the examined port.\n",
 229         CMD_HANDLER(cmd_do_spi_translate), (void *)&cmd_list_spi
 230 };
 231
 232 /** Command descriptor for SPI trasfer */
 233 cmd_des_t const cmd_des_spimst = {
 234         0, 0,
 235         "spimst*", "Request SPI master communication",
 236         "### Command syntax ###\n"
 237         "\n"
 238         "    spimst<SPI> <ADDR> <DATA>\n"
 239         "where\n"
 240         "\n"
 241         "- `<SPI>` is a number in range 0 - 4\n"
 242         "- `<ADDR>` is a number in range 0 - 2\n"
 243         "- `<DATA>` is a sequence of hexadecimal numbers, separated by spaces, e.g. 12 AA CD\n"
 244         "\n"
 245         "### Description ###\n"
 246         "\n"
 247         "The command sends given data to the SPI peripheral and prints the\n"
 248         "response. The response contains the address and the received data in\n"
 249         "parentheses.\n"
 250         "\n"
 251         "### Example ###\n"
 252         "\n"
 253         "    --> spimst1 0 7F 00 00\n"
 254         "    spirx:0x0(0x3f,0xc0,0xff)\n"
 255         "\n"
 256         "Sends reset command (0x7F0000) to the DIN peripheral.\n",
 257         CMD_HANDLER(cmd_do_spimst), (void *)&cmd_list_spi
 258 };
 259
 260 /** List of commands for SPI, defined as external */
 261 cmd_des_t const *cmd_list_spi[] = {
 262         &cmd_des_spi_translate,
 263         &cmd_des_spimst,
 264         NULL
 265 };