kernel/drivers/staging/fsl-mc/include/mc-sys.h

   1 /* Copyright 2013-2014 Freescale Semiconductor Inc.
   2  *
   3  * Interface of the I/O services to send MC commands to the MC hardware
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the above-listed copyright holders nor the
  13  *       names of any contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  *
  17  * ALTERNATIVELY, this software may be distributed under the terms of the
  18  * GNU General Public License ("GPL") as published by the Free Software
  19  * Foundation, either version 2 of that License or (at your option) any
  20  * later version.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef _FSL_MC_SYS_H
  36 #define _FSL_MC_SYS_H
  37
  38 #include <linux/types.h>
  39 #include <linux/errno.h>
  40 #include <linux/io.h>
  41 #include <linux/dma-mapping.h>
  42
  43 struct fsl_mc_resource;
  44 struct mc_command;
  45
  46 /**
  47  * struct fsl_mc_io - MC I/O object to be passed-in to mc_send_command()
  48  * @dev: device associated with this Mc I/O object
  49  * @flags: flags for mc_send_command()
  50  * @portal_size: MC command portal size in bytes
  51  * @portal_phys_addr: MC command portal physical address
  52  * @portal_virt_addr: MC command portal virtual address
  53  * @resource: generic resource associated with the MC portal if
  54  * the MC portal came from a resource pool, or NULL if the MC portal
  55  * is permanently bound to a device (e.g., a DPRC)
  56  */
  57 struct fsl_mc_io {
  58         struct device *dev;
  59         uint32_t flags;
  60         uint32_t portal_size;
  61         phys_addr_t portal_phys_addr;
  62         void __iomem *portal_virt_addr;
  63         struct fsl_mc_resource *resource;
  64 };
  65
  66 int __must_check fsl_create_mc_io(struct device *dev,
  67                                   phys_addr_t mc_portal_phys_addr,
  68                                   uint32_t mc_portal_size,
  69                                   struct fsl_mc_resource *resource,
  70                                   uint32_t flags, struct fsl_mc_io **new_mc_io);
  71
  72 void fsl_destroy_mc_io(struct fsl_mc_io *mc_io);
  73
  74 int mc_send_command(struct fsl_mc_io *mc_io, struct mc_command *cmd);
  75
  76 #endif /* _FSL_MC_SYS_H */