100 lines
3.9 KiB
C
100 lines
3.9 KiB
C
/*
|
|
* Copyright 2013-2016 Freescale Semiconductor Inc.
|
|
*
|
|
* Interface of the I/O services to send MC commands to the MC hardware
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of the above-listed copyright holders nor the
|
|
* names of any contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
*
|
|
* ALTERNATIVELY, this software may be distributed under the terms of the
|
|
* GNU General Public License ("GPL") as published by the Free Software
|
|
* Foundation, either version 2 of that License or (at your option) any
|
|
* later version.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _FSL_MC_SYS_H
|
|
#define _FSL_MC_SYS_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/errno.h>
|
|
#include <linux/mutex.h>
|
|
#include <linux/spinlock.h>
|
|
|
|
/**
|
|
* Bit masks for a MC I/O object (struct fsl_mc_io) flags
|
|
*/
|
|
#define FSL_MC_IO_ATOMIC_CONTEXT_PORTAL 0x0001
|
|
|
|
struct fsl_mc_resource;
|
|
struct mc_command;
|
|
|
|
/**
|
|
* struct fsl_mc_io - MC I/O object to be passed-in to mc_send_command()
|
|
* @dev: device associated with this Mc I/O object
|
|
* @flags: flags for mc_send_command()
|
|
* @portal_size: MC command portal size in bytes
|
|
* @portal_phys_addr: MC command portal physical address
|
|
* @portal_virt_addr: MC command portal virtual address
|
|
* @dpmcp_dev: pointer to the DPMCP device associated with the MC portal.
|
|
*
|
|
* Fields are only meaningful if the FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is not
|
|
* set:
|
|
* @mutex: Mutex to serialize mc_send_command() calls that use the same MC
|
|
* portal, if the fsl_mc_io object was created with the
|
|
* FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag off. mc_send_command() calls for this
|
|
* fsl_mc_io object must be made only from non-atomic context.
|
|
*
|
|
* Fields are only meaningful if the FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is
|
|
* set:
|
|
* @spinlock: Spinlock to serialize mc_send_command() calls that use the same MC
|
|
* portal, if the fsl_mc_io object was created with the
|
|
* FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag on. mc_send_command() calls for this
|
|
* fsl_mc_io object can be made from atomic or non-atomic context.
|
|
*/
|
|
struct fsl_mc_io {
|
|
struct device *dev;
|
|
u16 flags;
|
|
u16 portal_size;
|
|
phys_addr_t portal_phys_addr;
|
|
void __iomem *portal_virt_addr;
|
|
struct fsl_mc_device *dpmcp_dev;
|
|
union {
|
|
/*
|
|
* This field is only meaningful if the
|
|
* FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is not set
|
|
*/
|
|
struct mutex mutex; /* serializes mc_send_command() */
|
|
|
|
/*
|
|
* This field is only meaningful if the
|
|
* FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is set
|
|
*/
|
|
spinlock_t spinlock; /* serializes mc_send_command() */
|
|
};
|
|
};
|
|
|
|
int mc_send_command(struct fsl_mc_io *mc_io, struct mc_command *cmd);
|
|
|
|
#endif /* _FSL_MC_SYS_H */
|