drivers/bus/fslmc/mc/mc_sys.c

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license. When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  *   BSD LICENSE
   6  *
   7  * Copyright 2013-2015 Freescale Semiconductor Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  * * Redistributions of source code must retain the above copyright
  12  * notice, this list of conditions and the following disclaimer.
  13  * * Redistributions in binary form must reproduce the above copyright
  14  * notice, this list of conditions and the following disclaimer in the
  15  * documentation and/or other materials provided with the distribution.
  16  * * Neither the name of the above-listed copyright holders nor the
  17  * names of any contributors may be used to endorse or promote products
  18  * derived from this software without specific prior written permission.
  19  *
  20  *   GPL LICENSE SUMMARY
  21  *
  22  * ALTERNATIVELY, this software may be distributed under the terms of the
  23  * GNU General Public License ("GPL") as published by the Free Software
  24  * Foundation, either version 2 of that License or (at your option) any
  25  * later version.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGE.
  38  */
  39 #include <fsl_mc_sys.h>
  40 #include <fsl_mc_cmd.h>
  41
  42 #include <rte_spinlock.h>
  43
  44 /** User space framework uses MC Portal in shared mode. Following change
  45  * introduces lock in MC FLIB
  46  */
  47
  48 /**
  49  * A static spinlock initializer.
  50  */
  51 static rte_spinlock_t mc_portal_lock = RTE_SPINLOCK_INITIALIZER;
  52
  53 static int mc_status_to_error(enum mc_cmd_status status)
  54 {
  55         switch (status) {
  56         case MC_CMD_STATUS_OK:
  57                 return 0;
  58         case MC_CMD_STATUS_AUTH_ERR:
  59                 return -EACCES; /* Token error */
  60         case MC_CMD_STATUS_NO_PRIVILEGE:
  61                 return -EPERM; /* Permission denied */
  62         case MC_CMD_STATUS_DMA_ERR:
  63                 return -EIO; /* Input/Output error */
  64         case MC_CMD_STATUS_CONFIG_ERR:
  65                 return -EINVAL; /* Device not configured */
  66         case MC_CMD_STATUS_TIMEOUT:
  67                 return -ETIMEDOUT; /* Operation timed out */
  68         case MC_CMD_STATUS_NO_RESOURCE:
  69                 return -ENAVAIL; /* Resource temporarily unavailable */
  70         case MC_CMD_STATUS_NO_MEMORY:
  71                 return -ENOMEM; /* Cannot allocate memory */
  72         case MC_CMD_STATUS_BUSY:
  73                 return -EBUSY; /* Device busy */
  74         case MC_CMD_STATUS_UNSUPPORTED_OP:
  75                 return -ENOTSUP; /* Operation not supported by device */
  76         case MC_CMD_STATUS_INVALID_STATE:
  77                 return -ENODEV; /* Invalid device state */
  78         default:
  79                 break;
  80         }
  81
  82         /* Not expected to reach here */
  83         return -EINVAL;
  84 }
  85
  86 int mc_send_command(struct fsl_mc_io *mc_io, struct mc_command *cmd)
  87 {
  88         enum mc_cmd_status status;
  89
  90         if (!mc_io || !mc_io->regs)
  91                 return -EACCES;
  92
  93         /* --- Call lock function here in case portal is shared --- */
  94         rte_spinlock_lock(&mc_portal_lock);
  95
  96         mc_write_command(mc_io->regs, cmd);
  97
  98         /* Spin until status changes */
  99         do {
 100                 status = MC_CMD_HDR_READ_STATUS(ioread64(mc_io->regs));
 101
 102                 /* --- Call wait function here to prevent blocking ---
 103                  * Change the loop condition accordingly to exit on timeout.
 104                  */
 105         } while (status == MC_CMD_STATUS_READY);
 106
 107         /* Read the response back into the command buffer */
 108         mc_read_response(mc_io->regs, cmd);
 109
 110         /* --- Call unlock function here in case portal is shared --- */
 111         rte_spinlock_unlock(&mc_portal_lock);
 112
 113         return mc_status_to_error(status);
 114 }