text: /* Copyright 2013-2016 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.
   */
  #ifndef __FSL_DPCON_H
  #define __FSL_DPCON_H
  
  /* Data Path Concentrator API
   * Contains initialization APIs and runtime control APIs for DPCON
   */
  
  struct fsl_mc_io;
  
  /** General DPCON macros */
  
  /**
   * Use it to disable notifications; see dpcon_set_notification()
   */
  #define DPCON_INVALID_DPIO_ID		(int)(-1)
  
  /**
   * dpcon_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_'
   * @dpcon_id:	DPCON 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 dpcon_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 dpcon_open(struct fsl_mc_io *mc_io,
  	       uint32_t		cmd_flags,
  	       int		dpcon_id,
  	       uint16_t		*token);
  
  /**
   * dpcon_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 DPCON 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 dpcon_close(struct fsl_mc_io	*mc_io,
  		uint32_t		cmd_flags,
  		uint16_t		token);
  
  /**
   * struct dpcon_cfg - Structure representing DPCON configuration
   * @num_priorities: Number of priorities for the DPCON channel (1-8)
   */
  struct dpcon_cfg {
  	uint8_t num_priorities;
  };
  
  /**
   * dpcon_create() - Create the DPCON object.
   * @mc_io:	Pointer to MC portal's I/O object
   * @dprc_token:	Parent container token; '0' for default container
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @cfg:	Configuration structure
   * @obj_id: returned object id
   *
   * Create the DPCON 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.
   *
   * The function accepts an authentication token of a parent
   * container that this object should be assigned to. The token
   * can be '0' so the object will be assigned to the default container.
   * The newly created object can be opened with the returned
   * object id and using the container's associated tokens and MC portals.
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_create(struct fsl_mc_io	*mc_io,
  		 uint16_t		dprc_token,
  		uint32_t		cmd_flags,
  		const struct dpcon_cfg	*cfg,
  		uint32_t		*obj_id);
  
  /**
   * dpcon_destroy() - Destroy the DPCON object and release all its resources.
   * @mc_io:	Pointer to MC portal's I/O object
   * @dprc_token: Parent container token; '0' for default container
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @object_id:	The object id; it must be a valid id within the container that
   * created this object;
   *
   * The function accepts the authentication token of the parent container that
   * created the object (not the one that currently owns the object). The object
   * is searched within parent using the provided 'object_id'.
   * All tokens to the object must be closed before calling destroy.
   *
   * Return:	'0' on Success; error code otherwise.
   */
  int dpcon_destroy(struct fsl_mc_io	*mc_io,
  		  uint16_t		dprc_token,
  		uint32_t		cmd_flags,
  		uint32_t		object_id);
  
  /**
   * dpcon_enable() - Enable the DPCON
   * @mc_io:	Pointer to MC portal's I/O object
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @token:	Token of DPCON object
   *
   * Return:	'0' on Success; Error code otherwise
   */
  int dpcon_enable(struct fsl_mc_io	*mc_io,
  		 uint32_t		cmd_flags,
  		 uint16_t		token);
  
  /**
   * dpcon_disable() - Disable the DPCON
   * @mc_io:	Pointer to MC portal's I/O object
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @token:	Token of DPCON object
   *
   * Return:	'0' on Success; Error code otherwise
   */
  int dpcon_disable(struct fsl_mc_io	*mc_io,
  		  uint32_t		cmd_flags,
  		  uint16_t		token);
  
  /**
   * dpcon_is_enabled() -	Check if the DPCON 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 DPCON object
   * @en:		Returns '1' if object is enabled; '0' otherwise
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_is_enabled(struct fsl_mc_io	*mc_io,
  		     uint32_t		cmd_flags,
  		     uint16_t		token,
  		     int		*en);
  
  /**
   * dpcon_reset() - Reset the DPCON, 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 DPCON object
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_reset(struct fsl_mc_io	*mc_io,
  		uint32_t		cmd_flags,
  		uint16_t		token);
  
  /**
   * dpcon_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 DPCON 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 dpcon_set_irq_enable(struct fsl_mc_io	*mc_io,
  			 uint32_t		cmd_flags,
  			 uint16_t		token,
  			 uint8_t		irq_index,
  			 uint8_t		en);
  
  /**
   * dpcon_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 DPCON object
   * @irq_index:	The interrupt index to configure
   * @en:		Returned interrupt state - enable = 1, disable = 0
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_get_irq_enable(struct fsl_mc_io	*mc_io,
  			 uint32_t		cmd_flags,
  			 uint16_t		token,
  			 uint8_t		irq_index,
  			 uint8_t		*en);
  
  /**
   * dpcon_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 DPCON 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 dpcon_set_irq_mask(struct fsl_mc_io	*mc_io,
  		       uint32_t		cmd_flags,
  		       uint16_t		token,
  		       uint8_t		irq_index,
  		       uint32_t		mask);
  
  /**
   * dpcon_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 DPCON 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 dpcon_get_irq_mask(struct fsl_mc_io	*mc_io,
  		       uint32_t		cmd_flags,
  		       uint16_t		token,
  		       uint8_t		irq_index,
  		       uint32_t		*mask);
  
  /**
   * dpcon_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 DPCON object
   * @irq_index:	The interrupt index to configure
   * @status:	interrupts status - one bit per cause:
   *			0 = no interrupt pending
   *			1 = interrupt pending
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_get_irq_status(struct fsl_mc_io	*mc_io,
  			 uint32_t		cmd_flags,
  			 uint16_t		token,
  			 uint8_t		irq_index,
  			 uint32_t		*status);
  
  /**
   * dpcon_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 DPCON 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 dpcon_clear_irq_status(struct fsl_mc_io	*mc_io,
  			   uint32_t		cmd_flags,
  			   uint16_t		token,
  			   uint8_t		irq_index,
  			   uint32_t		status);
  
  /**
   * struct dpcon_attr - Structure representing DPCON attributes
   * @id: DPCON object ID
   * @qbman_ch_id: Channel ID to be used by dequeue operation
   * @num_priorities: Number of priorities for the DPCON channel (1-8)
   */
  struct dpcon_attr {
  	int id;
  	uint16_t qbman_ch_id;
  	uint8_t num_priorities;
  };
  
  /**
   * dpcon_get_attributes() - Retrieve DPCON 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 DPCON object
   * @attr:	Object's attributes
   *
   * Return:	'0' on Success; Error code otherwise.
   */
  int dpcon_get_attributes(struct fsl_mc_io	*mc_io,
  			 uint32_t		cmd_flags,
  			 uint16_t		token,
  			 struct dpcon_attr	*attr);
  
  /**
   * struct dpcon_notification_cfg - Structure representing notification
   *					parameters
   * @dpio_id:	DPIO object ID; must be configured with a notification channel;
   *	to disable notifications set it to 'DPCON_INVALID_DPIO_ID';
   * @priority:	Priority selection within the DPIO channel; valid values
   *		are 0-7, depending on the number of priorities in that channel
   * @user_ctx:	User context value provided with each CDAN message
   */
  struct dpcon_notification_cfg {
  	int		dpio_id;
  	uint8_t		priority;
  	uint64_t	user_ctx;
  };
  
  /**
   * dpcon_set_notification() - Set DPCON notification destination
   * @mc_io:	Pointer to MC portal's I/O object
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @token:	Token of DPCON object
   * @cfg:	Notification parameters
   *
   * Return:	'0' on Success; Error code otherwise
   */
  int dpcon_set_notification(struct fsl_mc_io			*mc_io,
  			   uint32_t				cmd_flags,
  			   uint16_t				token,
  			   struct dpcon_notification_cfg	*cfg);
  
  /**
   * dpcon_get_api_version() - Get Data Path Concentrator API version
   * @mc_io:  Pointer to MC portal's I/O object
   * @cmd_flags:	Command flags; one or more of 'MC_CMD_FLAG_'
   * @major_ver:	Major version of data path concentrator API
   * @minor_ver:	Minor version of data path concentrator API
   *
   * Return:  '0' on Success; Error code otherwise.
   */
  int dpcon_get_api_version(struct fsl_mc_io *mc_io,
  			  uint32_t cmd_flags,
  			  uint16_t *major_ver,
  			  uint16_t *minor_ver);
  
  #endif /* __FSL_DPCON_H */
  