drivers/staging/fsl-mc/bus/dpbp.c - kernel/quantenna - Git at Google

 /* Copyright 2013-2014 Freescale Semiconductor Inc.
 *
 * 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.
 */
 #include "../include/mc-sys.h"
 #include "../include/mc-cmd.h"
 #include "../include/dpbp.h"
 #include "../include/dpbp-cmd.h"

 /**
  * dpbp_open() - Open a control session for the specified object.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @dpbp_id:	DPBP unique ID
  * @token:	Returned token; use in subsequent API calls
  *
  * This function can be used to open a control session for an
  * already created object; an object may have been declared in
  * the DPL or by calling the dpbp_create function.
  * This function returns a unique authentication token,
  * associated with the specific object ID and the specific MC
  * portal; this token must be used in all subsequent commands for
  * this specific object
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_open(struct fsl_mc_io *mc_io,
 	      u32 cmd_flags,
 	      int dpbp_id,
 	      u16 *token)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_OPEN,
 					  cmd_flags, 0);
 	cmd.params[0] |= mc_enc(0, 32, dpbp_id);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*token = MC_CMD_HDR_READ_TOKEN(cmd.header);

 	return err;
 }
 EXPORT_SYMBOL(dpbp_open);

 /**
  * dpbp_close() - Close the control session of the object
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  *
  * After this function is called, no further operations are
  * allowed on the object without opening a new control session.
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_close(struct fsl_mc_io *mc_io,
 	       u32 cmd_flags,
 	       u16 token)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CLOSE, cmd_flags,
 					  token);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }
 EXPORT_SYMBOL(dpbp_close);

 /**
  * dpbp_create() - Create the DPBP object.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @cfg:	Configuration structure
  * @token:	Returned token; use in subsequent API calls
  *
  * Create the DPBP object, allocate required resources and
  * perform required initialization.
  *
  * The object can be created either by declaring it in the
  * DPL file, or by calling this function.
  * This function returns a unique authentication token,
  * associated with the specific object ID and the specific MC
  * portal; this token must be used in all subsequent calls to
  * this specific object. For objects that are created using the
  * DPL file, call dpbp_open function to get an authentication
  * token first.
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_create(struct fsl_mc_io *mc_io,
 		u32 cmd_flags,
 		const struct dpbp_cfg *cfg,
 		u16 *token)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	(void)(cfg); /* unused */

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CREATE,
 					  cmd_flags, 0);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*token = MC_CMD_HDR_READ_TOKEN(cmd.header);

 	return 0;
 }

 /**
  * dpbp_destroy() - Destroy the DPBP object and release all its resources.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  *
  * Return:	'0' on Success; error code otherwise.
  */
 int dpbp_destroy(struct fsl_mc_io *mc_io,
 		 u32 cmd_flags,
 		 u16 token)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_DESTROY,
 					  cmd_flags, token);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_enable() - Enable the DPBP.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_enable(struct fsl_mc_io *mc_io,
 		u32 cmd_flags,
 		u16 token)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_ENABLE, cmd_flags,
 					  token);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }
 EXPORT_SYMBOL(dpbp_enable);

 /**
  * dpbp_disable() - Disable the DPBP.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_disable(struct fsl_mc_io *mc_io,
 		 u32 cmd_flags,
 		 u16 token)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_DISABLE,
 					  cmd_flags, token);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }
 EXPORT_SYMBOL(dpbp_disable);

 /**
  * dpbp_is_enabled() - Check if the DPBP is enabled.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @en:		Returns '1' if object is enabled; '0' otherwise
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_is_enabled(struct fsl_mc_io *mc_io,
 		    u32 cmd_flags,
 		    u16 token,
 		    int *en)
 {
 	struct mc_command cmd = { 0 };
 	int err;
 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_IS_ENABLED, cmd_flags,
 					  token);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*en = (int)mc_dec(cmd.params[0], 0, 1);

 	return 0;
 }

 /**
  * dpbp_reset() - Reset the DPBP, returns the object to initial state.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_reset(struct fsl_mc_io *mc_io,
 	       u32 cmd_flags,
 	       u16 token)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_RESET,
 					  cmd_flags, token);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_set_irq() - Set IRQ information for the DPBP to trigger an interrupt.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	Identifies the interrupt index to configure
  * @irq_cfg:	IRQ configuration
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_set_irq(struct fsl_mc_io *mc_io,
 		 u32 cmd_flags,
 		 u16 token,
 		 u8 irq_index,
 		 struct dpbp_irq_cfg *irq_cfg)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(0, 8, irq_index);
 	cmd.params[0] |= mc_enc(32, 32, irq_cfg->val);
 	cmd.params[1] |= mc_enc(0, 64, irq_cfg->addr);
 	cmd.params[2] |= mc_enc(0, 32, irq_cfg->irq_num);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_get_irq() - Get IRQ information from the DPBP.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @type:	Interrupt type: 0 represents message interrupt
  *		type (both irq_addr and irq_val are valid)
  * @irq_cfg:	IRQ attributes
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_irq(struct fsl_mc_io *mc_io,
 		 u32 cmd_flags,
 		 u16 token,
 		 u8 irq_index,
 		 int *type,
 		 struct dpbp_irq_cfg *irq_cfg)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	irq_cfg->val = (u32)mc_dec(cmd.params[0], 0, 32);
 	irq_cfg->addr = (u64)mc_dec(cmd.params[1], 0, 64);
 	irq_cfg->irq_num = (int)mc_dec(cmd.params[2], 0, 32);
 	*type = (int)mc_dec(cmd.params[2], 32, 32);
 	return 0;
 }

 /**
  * dpbp_set_irq_enable() - Set overall interrupt state.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @en:	Interrupt state - enable = 1, disable = 0
  *
  * Allows GPP software to control when interrupts are generated.
  * Each interrupt can have up to 32 causes.  The enable/disable control's the
  * overall interrupt state. if the interrupt is disabled no causes will cause
  * an interrupt.
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_set_irq_enable(struct fsl_mc_io *mc_io,
 			u32 cmd_flags,
 			u16 token,
 			u8 irq_index,
 			u8 en)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ_ENABLE,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(0, 8, en);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_get_irq_enable() - Get overall interrupt state
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @en:		Returned interrupt state - enable = 1, disable = 0
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_irq_enable(struct fsl_mc_io *mc_io,
 			u32 cmd_flags,
 			u16 token,
 			u8 irq_index,
 			u8 *en)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_ENABLE,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*en = (u8)mc_dec(cmd.params[0], 0, 8);
 	return 0;
 }

 /**
  * dpbp_set_irq_mask() - Set interrupt mask.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @mask:	Event mask to trigger interrupt;
  *			each bit:
  *				0 = ignore event
  *				1 = consider event for asserting IRQ
  *
  * Every interrupt can have up to 32 causes and the interrupt model supports
  * masking/unmasking each cause independently
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_set_irq_mask(struct fsl_mc_io *mc_io,
 		      u32 cmd_flags,
 		      u16 token,
 		      u8 irq_index,
 		      u32 mask)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ_MASK,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(0, 32, mask);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_get_irq_mask() - Get interrupt mask.
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @mask:	Returned event mask to trigger interrupt
  *
  * Every interrupt can have up to 32 causes and the interrupt model supports
  * masking/unmasking each cause independently
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_irq_mask(struct fsl_mc_io *mc_io,
 		      u32 cmd_flags,
 		      u16 token,
 		      u8 irq_index,
 		      u32 *mask)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_MASK,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*mask = (u32)mc_dec(cmd.params[0], 0, 32);
 	return 0;
 }

 /**
  * dpbp_get_irq_status() - Get the current status of any pending interrupts.
  *
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @status:	Returned interrupts status - one bit per cause:
  *			0 = no interrupt pending
  *			1 = interrupt pending
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_irq_status(struct fsl_mc_io *mc_io,
 			u32 cmd_flags,
 			u16 token,
 			u8 irq_index,
 			u32 *status)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_STATUS,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(0, 32, *status);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	*status = (u32)mc_dec(cmd.params[0], 0, 32);
 	return 0;
 }

 /**
  * dpbp_clear_irq_status() - Clear a pending interrupt's status
  *
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @irq_index:	The interrupt index to configure
  * @status:	Bits to clear (W1C) - one bit per cause:
  *					0 = don't change
  *					1 = clear status bit
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_clear_irq_status(struct fsl_mc_io *mc_io,
 			  u32 cmd_flags,
 			  u16 token,
 			  u8 irq_index,
 			  u32 status)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CLEAR_IRQ_STATUS,
 					  cmd_flags, token);
 	cmd.params[0] |= mc_enc(0, 32, status);
 	cmd.params[0] |= mc_enc(32, 8, irq_index);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_get_attributes - Retrieve DPBP attributes.
  *
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @attr:	Returned object's attributes
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_attributes(struct fsl_mc_io *mc_io,
 			u32 cmd_flags,
 			u16 token,
 			struct dpbp_attr *attr)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_ATTR,
 					  cmd_flags, token);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	attr->bpid = (u16)mc_dec(cmd.params[0], 16, 16);
 	attr->id = (int)mc_dec(cmd.params[0], 32, 32);
 	attr->version.major = (u16)mc_dec(cmd.params[1], 0, 16);
 	attr->version.minor = (u16)mc_dec(cmd.params[1], 16, 16);
 	return 0;
 }
 EXPORT_SYMBOL(dpbp_get_attributes);

 /**
  * dpbp_set_notifications() - Set notifications towards software
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @cfg:	notifications configuration
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_set_notifications(struct fsl_mc_io *mc_io,
 			   u32 cmd_flags,
 			   u16 token,
 			   struct dpbp_notification_cfg	*cfg)
 {
 	struct mc_command cmd = { 0 };

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_NOTIFICATIONS,
 					  cmd_flags,
 					  token);

 	cmd.params[0] |= mc_enc(0, 32, cfg->depletion_entry);
 	cmd.params[0] |= mc_enc(32, 32, cfg->depletion_exit);
 	cmd.params[1] |= mc_enc(0, 32, cfg->surplus_entry);
 	cmd.params[1] |= mc_enc(32, 32, cfg->surplus_exit);
 	cmd.params[2] |= mc_enc(0, 16, cfg->options);
 	cmd.params[3] |= mc_enc(0, 64, cfg->message_ctx);
 	cmd.params[4] |= mc_enc(0, 64, cfg->message_iova);

 	/* send command to mc*/
 	return mc_send_command(mc_io, &cmd);
 }

 /**
  * dpbp_get_notifications() - Get the notifications configuration
  * @mc_io:	Pointer to MC portal's I/O object
  * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
  * @token:	Token of DPBP object
  * @cfg:	notifications configuration
  *
  * Return:	'0' on Success; Error code otherwise.
  */
 int dpbp_get_notifications(struct fsl_mc_io *mc_io,
 			   u32 cmd_flags,
 			   u16 token,
 			   struct dpbp_notification_cfg	*cfg)
 {
 	struct mc_command cmd = { 0 };
 	int err;

 	/* prepare command */
 	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_NOTIFICATIONS,
 					  cmd_flags,
 					  token);

 	/* send command to mc*/
 	err = mc_send_command(mc_io, &cmd);
 	if (err)
 		return err;

 	/* retrieve response parameters */
 	cfg->depletion_entry = (u32)mc_dec(cmd.params[0], 0, 32);
 	cfg->depletion_exit = (u32)mc_dec(cmd.params[0], 32, 32);
 	cfg->surplus_entry = (u32)mc_dec(cmd.params[1], 0, 32);
 	cfg->surplus_exit = (u32)mc_dec(cmd.params[1], 32, 32);
 	cfg->options = (u16)mc_dec(cmd.params[2], 0, 16);
 	cfg->message_ctx = (u64)mc_dec(cmd.params[3], 0, 64);
 	cfg->message_iova = (u64)mc_dec(cmd.params[4], 0, 64);

 	return 0;
 }
	/* Copyright 2013-2014 Freescale Semiconductor Inc.
	*
	* 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.
	*/
	#include "../include/mc-sys.h"
	#include "../include/mc-cmd.h"
	#include "../include/dpbp.h"
	#include "../include/dpbp-cmd.h"

	/**
	* dpbp_open() - Open a control session for the specified object.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @dpbp_id: DPBP unique ID
	* @token: Returned token; use in subsequent API calls
	*
	* This function can be used to open a control session for an
	* already created object; an object may have been declared in
	* the DPL or by calling the dpbp_create function.
	* This function returns a unique authentication token,
	* associated with the specific object ID and the specific MC
	* portal; this token must be used in all subsequent commands for
	* this specific object
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_open(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	int dpbp_id,
	u16 *token)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_OPEN,
	cmd_flags, 0);
	cmd.params[0] \|= mc_enc(0, 32, dpbp_id);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*token = MC_CMD_HDR_READ_TOKEN(cmd.header);

	return err;
	}
	EXPORT_SYMBOL(dpbp_open);

	/**
	* dpbp_close() - Close the control session of the object
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	*
	* After this function is called, no further operations are
	* allowed on the object without opening a new control session.
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_close(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CLOSE, cmd_flags,
	token);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}
	EXPORT_SYMBOL(dpbp_close);

	/**
	* dpbp_create() - Create the DPBP object.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @cfg: Configuration structure
	* @token: Returned token; use in subsequent API calls
	*
	* Create the DPBP object, allocate required resources and
	* perform required initialization.
	*
	* The object can be created either by declaring it in the
	* DPL file, or by calling this function.
	* This function returns a unique authentication token,
	* associated with the specific object ID and the specific MC
	* portal; this token must be used in all subsequent calls to
	* this specific object. For objects that are created using the
	* DPL file, call dpbp_open function to get an authentication
	* token first.
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_create(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	const struct dpbp_cfg *cfg,
	u16 *token)
	{
	struct mc_command cmd = { 0 };
	int err;

	(void)(cfg); /* unused */

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CREATE,
	cmd_flags, 0);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*token = MC_CMD_HDR_READ_TOKEN(cmd.header);

	return 0;
	}

	/**
	* dpbp_destroy() - Destroy the DPBP object and release all its resources.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	*
	* Return: '0' on Success; error code otherwise.
	*/
	int dpbp_destroy(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_DESTROY,
	cmd_flags, token);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_enable() - Enable the DPBP.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_enable(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_ENABLE, cmd_flags,
	token);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}
	EXPORT_SYMBOL(dpbp_enable);

	/**
	* dpbp_disable() - Disable the DPBP.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_disable(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_DISABLE,
	cmd_flags, token);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}
	EXPORT_SYMBOL(dpbp_disable);

	/**
	* dpbp_is_enabled() - Check if the DPBP is enabled.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @en: Returns '1' if object is enabled; '0' otherwise
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_is_enabled(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	int *en)
	{
	struct mc_command cmd = { 0 };
	int err;
	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_IS_ENABLED, cmd_flags,
	token);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*en = (int)mc_dec(cmd.params[0], 0, 1);

	return 0;
	}

	/**
	* dpbp_reset() - Reset the DPBP, returns the object to initial state.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_reset(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_RESET,
	cmd_flags, token);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_set_irq() - Set IRQ information for the DPBP to trigger an interrupt.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: Identifies the interrupt index to configure
	* @irq_cfg: IRQ configuration
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_set_irq(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	struct dpbp_irq_cfg *irq_cfg)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(0, 8, irq_index);
	cmd.params[0] \|= mc_enc(32, 32, irq_cfg->val);
	cmd.params[1] \|= mc_enc(0, 64, irq_cfg->addr);
	cmd.params[2] \|= mc_enc(0, 32, irq_cfg->irq_num);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_get_irq() - Get IRQ information from the DPBP.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @type: Interrupt type: 0 represents message interrupt
	* type (both irq_addr and irq_val are valid)
	* @irq_cfg: IRQ attributes
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_irq(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	int *type,
	struct dpbp_irq_cfg *irq_cfg)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	irq_cfg->val = (u32)mc_dec(cmd.params[0], 0, 32);
	irq_cfg->addr = (u64)mc_dec(cmd.params[1], 0, 64);
	irq_cfg->irq_num = (int)mc_dec(cmd.params[2], 0, 32);
	*type = (int)mc_dec(cmd.params[2], 32, 32);
	return 0;
	}

	/**
	* dpbp_set_irq_enable() - Set overall interrupt state.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @en: Interrupt state - enable = 1, disable = 0
	*
	* Allows GPP software to control when interrupts are generated.
	* Each interrupt can have up to 32 causes. The enable/disable control's the
	* overall interrupt state. if the interrupt is disabled no causes will cause
	* an interrupt.
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_set_irq_enable(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u8 en)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ_ENABLE,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(0, 8, en);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_get_irq_enable() - Get overall interrupt state
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @en: Returned interrupt state - enable = 1, disable = 0
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_irq_enable(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u8 *en)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_ENABLE,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*en = (u8)mc_dec(cmd.params[0], 0, 8);
	return 0;
	}

	/**
	* dpbp_set_irq_mask() - Set interrupt mask.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @mask: Event mask to trigger interrupt;
	* each bit:
	* 0 = ignore event
	* 1 = consider event for asserting IRQ
	*
	* Every interrupt can have up to 32 causes and the interrupt model supports
	* masking/unmasking each cause independently
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_set_irq_mask(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u32 mask)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_IRQ_MASK,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(0, 32, mask);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_get_irq_mask() - Get interrupt mask.
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @mask: Returned event mask to trigger interrupt
	*
	* Every interrupt can have up to 32 causes and the interrupt model supports
	* masking/unmasking each cause independently
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_irq_mask(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u32 *mask)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_MASK,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*mask = (u32)mc_dec(cmd.params[0], 0, 32);
	return 0;
	}

	/**
	* dpbp_get_irq_status() - Get the current status of any pending interrupts.
	*
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @status: Returned interrupts status - one bit per cause:
	* 0 = no interrupt pending
	* 1 = interrupt pending
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_irq_status(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u32 *status)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_IRQ_STATUS,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(0, 32, *status);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	*status = (u32)mc_dec(cmd.params[0], 0, 32);
	return 0;
	}

	/**
	* dpbp_clear_irq_status() - Clear a pending interrupt's status
	*
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @irq_index: The interrupt index to configure
	* @status: Bits to clear (W1C) - one bit per cause:
	* 0 = don't change
	* 1 = clear status bit
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_clear_irq_status(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	u8 irq_index,
	u32 status)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_CLEAR_IRQ_STATUS,
	cmd_flags, token);
	cmd.params[0] \|= mc_enc(0, 32, status);
	cmd.params[0] \|= mc_enc(32, 8, irq_index);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_get_attributes - Retrieve DPBP attributes.
	*
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @attr: Returned object's attributes
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_attributes(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	struct dpbp_attr *attr)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_ATTR,
	cmd_flags, token);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	attr->bpid = (u16)mc_dec(cmd.params[0], 16, 16);
	attr->id = (int)mc_dec(cmd.params[0], 32, 32);
	attr->version.major = (u16)mc_dec(cmd.params[1], 0, 16);
	attr->version.minor = (u16)mc_dec(cmd.params[1], 16, 16);
	return 0;
	}
	EXPORT_SYMBOL(dpbp_get_attributes);

	/**
	* dpbp_set_notifications() - Set notifications towards software
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @cfg: notifications configuration
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_set_notifications(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	struct dpbp_notification_cfg *cfg)
	{
	struct mc_command cmd = { 0 };

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_SET_NOTIFICATIONS,
	cmd_flags,
	token);

	cmd.params[0] \|= mc_enc(0, 32, cfg->depletion_entry);
	cmd.params[0] \|= mc_enc(32, 32, cfg->depletion_exit);
	cmd.params[1] \|= mc_enc(0, 32, cfg->surplus_entry);
	cmd.params[1] \|= mc_enc(32, 32, cfg->surplus_exit);
	cmd.params[2] \|= mc_enc(0, 16, cfg->options);
	cmd.params[3] \|= mc_enc(0, 64, cfg->message_ctx);
	cmd.params[4] \|= mc_enc(0, 64, cfg->message_iova);

	/* send command to mc*/
	return mc_send_command(mc_io, &cmd);
	}

	/**
	* dpbp_get_notifications() - Get the notifications configuration
	* @mc_io: Pointer to MC portal's I/O object
	* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
	* @token: Token of DPBP object
	* @cfg: notifications configuration
	*
	* Return: '0' on Success; Error code otherwise.
	*/
	int dpbp_get_notifications(struct fsl_mc_io *mc_io,
	u32 cmd_flags,
	u16 token,
	struct dpbp_notification_cfg *cfg)
	{
	struct mc_command cmd = { 0 };
	int err;

	/* prepare command */
	cmd.header = mc_encode_cmd_header(DPBP_CMDID_GET_NOTIFICATIONS,
	cmd_flags,
	token);

	/* send command to mc*/
	err = mc_send_command(mc_io, &cmd);
	if (err)
	return err;

	/* retrieve response parameters */
	cfg->depletion_entry = (u32)mc_dec(cmd.params[0], 0, 32);
	cfg->depletion_exit = (u32)mc_dec(cmd.params[0], 32, 32);
	cfg->surplus_entry = (u32)mc_dec(cmd.params[1], 0, 32);
	cfg->surplus_exit = (u32)mc_dec(cmd.params[1], 32, 32);
	cfg->options = (u16)mc_dec(cmd.params[2], 0, 16);
	cfg->message_ctx = (u64)mc_dec(cmd.params[3], 0, 64);
	cfg->message_iova = (u64)mc_dec(cmd.params[4], 0, 64);

	return 0;
	}