drivers/staging/fsl-mc/include/mc-cmd.h

   1 /* Copyright 2013-2015 Freescale Semiconductor Inc.
   2  *
   3  * Redistribution and use in source and binary forms, with or without
   4  * modification, are permitted provided that the following conditions are met:
   5  * * Redistributions of source code must retain the above copyright
   6  * notice, this list of conditions and the following disclaimer.
   7  * * Redistributions in binary form must reproduce the above copyright
   8  * notice, this list of conditions and the following disclaimer in the
   9  * documentation and/or other materials provided with the distribution.
  10  * * Neither the name of the above-listed copyright holders nor the
  11  * names of any contributors may be used to endorse or promote products
  12  * derived from this software without specific prior written permission.
  13  *
  14  *
  15  * ALTERNATIVELY, this software may be distributed under the terms of the
  16  * GNU General Public License ("GPL") as published by the Free Software
  17  * Foundation, either version 2 of that License or (at your option) any
  18  * later version.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 #ifndef __FSL_MC_CMD_H
  33 #define __FSL_MC_CMD_H
  34
  35 #define MC_CMD_NUM_OF_PARAMS    7
  36
  37 #define MAKE_UMASK64(_width) \
  38         ((u64)((_width) < 64 ? ((u64)1 << (_width)) - 1 : -1))
  39
  40 static inline u64 mc_enc(int lsoffset, int width, u64 val)
  41 {
  42         return (u64)(((u64)val & MAKE_UMASK64(width)) << lsoffset);
  43 }
  44
  45 static inline u64 mc_dec(u64 val, int lsoffset, int width)
  46 {
  47         return (u64)((val >> lsoffset) & MAKE_UMASK64(width));
  48 }
  49
  50 struct mc_command {
  51         u64 header;
  52         u64 params[MC_CMD_NUM_OF_PARAMS];
  53 };
  54
  55 enum mc_cmd_status {
  56         MC_CMD_STATUS_OK = 0x0, /* Completed successfully */
  57         MC_CMD_STATUS_READY = 0x1, /* Ready to be processed */
  58         MC_CMD_STATUS_AUTH_ERR = 0x3, /* Authentication error */
  59         MC_CMD_STATUS_NO_PRIVILEGE = 0x4, /* No privilege */
  60         MC_CMD_STATUS_DMA_ERR = 0x5, /* DMA or I/O error */
  61         MC_CMD_STATUS_CONFIG_ERR = 0x6, /* Configuration error */
  62         MC_CMD_STATUS_TIMEOUT = 0x7, /* Operation timed out */
  63         MC_CMD_STATUS_NO_RESOURCE = 0x8, /* No resources */
  64         MC_CMD_STATUS_NO_MEMORY = 0x9, /* No memory available */
  65         MC_CMD_STATUS_BUSY = 0xA, /* Device is busy */
  66         MC_CMD_STATUS_UNSUPPORTED_OP = 0xB, /* Unsupported operation */
  67         MC_CMD_STATUS_INVALID_STATE = 0xC /* Invalid state */
  68 };
  69
  70 /*
  71  * MC command flags
  72  */
  73
  74 /* High priority flag */
  75 #define MC_CMD_FLAG_PRI         0x00008000
  76 /* Command completion flag */
  77 #define MC_CMD_FLAG_INTR_DIS    0x01000000
  78
  79 /*
  80  * TODO Remove following two defines after completion of flib 8.0.0
  81  * integration
  82  */
  83 #define MC_CMD_PRI_LOW          0 /*!< Low Priority command indication */
  84 #define MC_CMD_PRI_HIGH         1 /*!< High Priority command indication */
  85
  86 #define MC_CMD_HDR_CMDID_O      52      /* Command ID field offset */
  87 #define MC_CMD_HDR_CMDID_S      12      /* Command ID field size */
  88 #define MC_CMD_HDR_TOKEN_O      38      /* Token field offset */
  89 #define MC_CMD_HDR_TOKEN_S      10      /* Token field size */
  90 #define MC_CMD_HDR_STATUS_O     16      /* Status field offset */
  91 #define MC_CMD_HDR_STATUS_S     8       /* Status field size*/
  92 #define MC_CMD_HDR_FLAGS_O      0       /* Flags field offset */
  93 #define MC_CMD_HDR_FLAGS_S      32      /* Flags field size*/
  94 #define MC_CMD_HDR_FLAGS_MASK   0xFF00FF00 /* Command flags mask */
  95
  96 #define MC_CMD_HDR_READ_STATUS(_hdr) \
  97         ((enum mc_cmd_status)mc_dec((_hdr), \
  98                 MC_CMD_HDR_STATUS_O, MC_CMD_HDR_STATUS_S))
  99
 100 #define MC_CMD_HDR_READ_TOKEN(_hdr) \
 101         ((u16)mc_dec((_hdr), MC_CMD_HDR_TOKEN_O, MC_CMD_HDR_TOKEN_S))
 102
 103 #define MC_CMD_HDR_READ_FLAGS(_hdr) \
 104         ((u32)mc_dec((_hdr), MC_CMD_HDR_FLAGS_O, MC_CMD_HDR_FLAGS_S))
 105
 106 #define MC_EXT_OP(_ext, _param, _offset, _width, _type, _arg) \
 107         ((_ext)[_param] |= mc_enc((_offset), (_width), _arg))
 108
 109 #define MC_CMD_OP(_cmd, _param, _offset, _width, _type, _arg) \
 110         ((_cmd).params[_param] |= mc_enc((_offset), (_width), _arg))
 111
 112 #define MC_RSP_OP(_cmd, _param, _offset, _width, _type, _arg) \
 113         (_arg = (_type)mc_dec(_cmd.params[_param], (_offset), (_width)))
 114
 115 static inline u64 mc_encode_cmd_header(u16 cmd_id,
 116                                        u32 cmd_flags,
 117                                        u16 token)
 118 {
 119         u64 hdr;
 120
 121         hdr = mc_enc(MC_CMD_HDR_CMDID_O, MC_CMD_HDR_CMDID_S, cmd_id);
 122         hdr |= mc_enc(MC_CMD_HDR_FLAGS_O, MC_CMD_HDR_FLAGS_S,
 123                        (cmd_flags & MC_CMD_HDR_FLAGS_MASK));
 124         hdr |= mc_enc(MC_CMD_HDR_TOKEN_O, MC_CMD_HDR_TOKEN_S, token);
 125         hdr |= mc_enc(MC_CMD_HDR_STATUS_O, MC_CMD_HDR_STATUS_S,
 126                        MC_CMD_STATUS_READY);
 127
 128         return hdr;
 129 }
 130
 131 #endif /* __FSL_MC_CMD_H */