mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-07-12 06:06:15 +09:00
1ebbe4fcf7
Current Management Complex Flibs does not support APIs for adding and destroying the objects. Add APIs to create and destroy objects for DPBP, DPIO, DPNI and DPRC. Signed-off-by: Prabhakar Kushwaha <prabhakar@freescale.com> Reviewed-by: York Sun <yorksun@freescale.com>
232 lines
7.1 KiB
C
232 lines
7.1 KiB
C
/*
|
|
* Copyright (C) 2013-2015 Freescale Semiconductor
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0+
|
|
*/
|
|
|
|
#ifndef _FSL_DPIO_H
|
|
#define _FSL_DPIO_H
|
|
|
|
/* DPIO Version */
|
|
#define DPIO_VER_MAJOR 3
|
|
#define DPIO_VER_MINOR 1
|
|
|
|
/* Command IDs */
|
|
#define DPIO_CMDID_CLOSE 0x800
|
|
#define DPIO_CMDID_OPEN 0x803
|
|
#define DPIO_CMDID_CREATE 0x903
|
|
#define DPIO_CMDID_DESTROY 0x900
|
|
|
|
#define DPIO_CMDID_ENABLE 0x002
|
|
#define DPIO_CMDID_DISABLE 0x003
|
|
#define DPIO_CMDID_GET_ATTR 0x004
|
|
#define DPIO_CMDID_RESET 0x005
|
|
|
|
/* cmd, param, offset, width, type, arg_name */
|
|
#define DPIO_CMD_OPEN(cmd, dpio_id) \
|
|
MC_CMD_OP(cmd, 0, 0, 32, int, dpio_id)
|
|
|
|
/* cmd, param, offset, width, type, arg_name */
|
|
#define DPIO_CMD_CREATE(cmd, cfg) \
|
|
do { \
|
|
MC_CMD_OP(cmd, 0, 16, 2, enum dpio_channel_mode, \
|
|
cfg->channel_mode);\
|
|
MC_CMD_OP(cmd, 0, 32, 8, uint8_t, cfg->num_priorities);\
|
|
} while (0)
|
|
|
|
/* cmd, param, offset, width, type, arg_name */
|
|
#define DPIO_RSP_GET_ATTR(cmd, attr) \
|
|
do { \
|
|
MC_RSP_OP(cmd, 0, 0, 32, int, attr->id);\
|
|
MC_RSP_OP(cmd, 0, 32, 16, uint16_t, attr->qbman_portal_id);\
|
|
MC_RSP_OP(cmd, 0, 48, 8, uint8_t, attr->num_priorities);\
|
|
MC_RSP_OP(cmd, 0, 56, 4, enum dpio_channel_mode, attr->channel_mode);\
|
|
MC_RSP_OP(cmd, 1, 0, 64, uint64_t, attr->qbman_portal_ce_offset);\
|
|
MC_RSP_OP(cmd, 2, 0, 64, uint64_t, attr->qbman_portal_ci_offset);\
|
|
MC_RSP_OP(cmd, 3, 0, 16, uint16_t, attr->version.major);\
|
|
MC_RSP_OP(cmd, 3, 16, 16, uint16_t, attr->version.minor);\
|
|
} while (0)
|
|
|
|
/* Data Path I/O Portal API
|
|
* Contains initialization APIs and runtime control APIs for DPIO
|
|
*/
|
|
|
|
struct fsl_mc_io;
|
|
|
|
/**
|
|
* dpio_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_'
|
|
* @dpio_id: DPIO 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 dpio_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 dpio_open(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
int dpio_id,
|
|
uint16_t *token);
|
|
|
|
/**
|
|
* dpio_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 DPIO object
|
|
*
|
|
* Return: '0' on Success; Error code otherwise.
|
|
*/
|
|
int dpio_close(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token);
|
|
|
|
/**
|
|
* enum dpio_channel_mode - DPIO notification channel mode
|
|
* @DPIO_NO_CHANNEL: No support for notification channel
|
|
* @DPIO_LOCAL_CHANNEL: Notifications on data availability can be received by a
|
|
* dedicated channel in the DPIO; user should point the queue's
|
|
* destination in the relevant interface to this DPIO
|
|
*/
|
|
enum dpio_channel_mode {
|
|
DPIO_NO_CHANNEL = 0,
|
|
DPIO_LOCAL_CHANNEL = 1,
|
|
};
|
|
|
|
/**
|
|
* struct dpio_cfg - Structure representing DPIO configuration
|
|
* @channel_mode: Notification channel mode
|
|
* @num_priorities: Number of priorities for the notification channel (1-8);
|
|
* relevant only if 'channel_mode = DPIO_LOCAL_CHANNEL'
|
|
*/
|
|
struct dpio_cfg {
|
|
enum dpio_channel_mode channel_mode;
|
|
uint8_t num_priorities;
|
|
};
|
|
|
|
/**
|
|
* dpio_create() - Create the DPIO 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 DPIO 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 dpio_open() function to get an authentication
|
|
* token first.
|
|
*
|
|
* Return: '0' on Success; Error code otherwise.
|
|
*/
|
|
int dpio_create(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
const struct dpio_cfg *cfg,
|
|
uint16_t *token);
|
|
|
|
/**
|
|
* dpio_destroy() - Destroy the DPIO 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 DPIO object
|
|
*
|
|
* Return: '0' on Success; Error code otherwise
|
|
*/
|
|
int dpio_destroy(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token);
|
|
|
|
/**
|
|
* dpio_enable() - Enable the DPIO, allow I/O portal operations.
|
|
* @mc_io: Pointer to MC portal's I/O object
|
|
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
|
|
* @token: Token of DPIO object
|
|
*
|
|
* Return: '0' on Success; Error code otherwise
|
|
*/
|
|
int dpio_enable(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token);
|
|
|
|
/**
|
|
* dpio_disable() - Disable the DPIO, stop any I/O portal operation.
|
|
* @mc_io: Pointer to MC portal's I/O object
|
|
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
|
|
* @token: Token of DPIO object
|
|
*
|
|
* Return: '0' on Success; Error code otherwise
|
|
*/
|
|
int dpio_disable(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token);
|
|
|
|
/**
|
|
* dpio_reset() - Reset the DPIO, 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 DPIO object
|
|
*
|
|
* Return: '0' on Success; Error code otherwise.
|
|
*/
|
|
int dpio_reset(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token);
|
|
|
|
/**
|
|
* struct dpio_attr - Structure representing DPIO attributes
|
|
* @id: DPIO object ID
|
|
* @version: DPIO version
|
|
* @qbman_portal_ce_offset: offset of the software portal cache-enabled area
|
|
* @qbman_portal_ci_offset: offset of the software portal cache-inhibited area
|
|
* @qbman_portal_id: Software portal ID
|
|
* @channel_mode: Notification channel mode
|
|
* @num_priorities: Number of priorities for the notification channel (1-8);
|
|
* relevant only if 'channel_mode = DPIO_LOCAL_CHANNEL'
|
|
*/
|
|
struct dpio_attr {
|
|
int id;
|
|
/**
|
|
* struct version - DPIO version
|
|
* @major: DPIO major version
|
|
* @minor: DPIO minor version
|
|
*/
|
|
struct {
|
|
uint16_t major;
|
|
uint16_t minor;
|
|
} version;
|
|
uint64_t qbman_portal_ce_offset;
|
|
uint64_t qbman_portal_ci_offset;
|
|
uint16_t qbman_portal_id;
|
|
enum dpio_channel_mode channel_mode;
|
|
uint8_t num_priorities;
|
|
};
|
|
|
|
/**
|
|
* dpio_get_attributes() - Retrieve DPIO 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 DPIO object
|
|
* @attr: Returned object's attributes
|
|
*
|
|
* Return: '0' on Success; Error code otherwise
|
|
*/
|
|
int dpio_get_attributes(struct fsl_mc_io *mc_io,
|
|
uint32_t cmd_flags,
|
|
uint16_t token,
|
|
struct dpio_attr *attr);
|
|
|
|
#endif /* _FSL_DPIO_H */
|