net/dpaa2: add DPRTC sub-module

This patch add support for dprtc
(Data Path Real Time Clock) sub-module
based on MC 10.16.0 flib.

It provides interface for PTP stack software
to access physical IEEE 1588 Real Time Clock.

Signed-off-by: Priyanka Jain <priyanka.jain@nxp.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
This commit is contained in:
Priyanka Jain 2019-08-29 15:57:30 +05:30 committed by Ferruh Yigit
parent e806bf878c
commit 184c39d165
5 changed files with 728 additions and 0 deletions

View File

@ -37,6 +37,7 @@ SRCS-$(CONFIG_RTE_LIBRTE_DPAA2_PMD) += dpaa2_mux.c
SRCS-$(CONFIG_RTE_LIBRTE_DPAA2_PMD) += mc/dpni.c
SRCS-$(CONFIG_RTE_LIBRTE_DPAA2_PMD) += mc/dpkg.c
SRCS-$(CONFIG_RTE_LIBRTE_DPAA2_PMD) += mc/dpdmux.c
SRCS-$(CONFIG_RTE_LIBRTE_IEEE1588) += mc/dprtc.c
LDLIBS += -lrte_bus_fslmc
LDLIBS += -lrte_mempool_dpaa2

View File

@ -0,0 +1,523 @@
/* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
* Copyright 2019 NXP
*/
#include <fsl_mc_sys.h>
#include <fsl_mc_cmd.h>
#include <fsl_dprtc.h>
#include <fsl_dprtc_cmd.h>
/** @addtogroup dprtc
* @{
*/
/**
* dprtc_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_'
* @dprtc_id: DPRTC 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 dprtc_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 dprtc_open(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
int dprtc_id,
uint16_t *token)
{
struct dprtc_cmd_open *cmd_params;
struct mc_command cmd = { 0 };
int err;
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_OPEN,
cmd_flags,
0);
cmd_params = (struct dprtc_cmd_open *)cmd.params;
cmd_params->dprtc_id = cpu_to_le32(dprtc_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);
return err;
}
/**
* dprtc_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 DPRTC 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 dprtc_close(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token)
{
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_CLOSE, cmd_flags,
token);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_create() - Create the DPRTC 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 DPRTC object, allocate required resources and
* perform required initialization.
*
* 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 dprtc_create(struct fsl_mc_io *mc_io,
uint16_t dprc_token,
uint32_t cmd_flags,
const struct dprtc_cfg *cfg,
uint32_t *obj_id)
{
struct mc_command cmd = { 0 };
int err;
(void)(cfg); /* unused */
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_CREATE,
cmd_flags,
dprc_token);
/* send command to mc*/
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
/* retrieve response parameters */
*obj_id = mc_cmd_read_object_id(&cmd);
return 0;
}
/**
* dprtc_destroy() - Destroy the DPRTC 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 dprtc_destroy(struct fsl_mc_io *mc_io,
uint16_t dprc_token,
uint32_t cmd_flags,
uint32_t object_id)
{
struct dprtc_cmd_destroy *cmd_params;
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_DESTROY,
cmd_flags,
dprc_token);
cmd_params = (struct dprtc_cmd_destroy *)cmd.params;
cmd_params->object_id = cpu_to_le32(object_id);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_enable() - Enable the DPRTC.
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_enable(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token)
{
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_ENABLE, cmd_flags,
token);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_disable() - Disable the DPRTC.
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_disable(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token)
{
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_DISABLE,
cmd_flags,
token);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_is_enabled() - Check if the DPRTC 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 DPRTC object
* @en: Returns '1' if object is enabled; '0' otherwise
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_is_enabled(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
int *en)
{
struct dprtc_rsp_is_enabled *rsp_params;
struct mc_command cmd = { 0 };
int err;
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_IS_ENABLED, cmd_flags,
token);
/* send command to mc*/
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
/* retrieve response parameters */
rsp_params = (struct dprtc_rsp_is_enabled *)cmd.params;
*en = dprtc_get_field(rsp_params->en, ENABLE);
return 0;
}
/**
* dprtc_reset() - Reset the DPRTC, 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 DPRTC object
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_reset(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token)
{
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_RESET,
cmd_flags,
token);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_get_attributes - Retrieve DPRTC 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 DPRTC object
* @attr: Returned object's attributes
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_get_attributes(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
struct dprtc_attr *attr)
{
struct dprtc_rsp_get_attributes *rsp_params;
struct mc_command cmd = { 0 };
int err;
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_GET_ATTR,
cmd_flags,
token);
/* send command to mc*/
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
/* retrieve response parameters */
rsp_params = (struct dprtc_rsp_get_attributes *)cmd.params;
attr->id = le32_to_cpu(rsp_params->id);
attr->paddr = le32_to_cpu(rsp_params->paddr);
attr->little_endian =
dprtc_get_field(rsp_params->little_endian, ENDIANNESS);
return 0;
}
/**
* dprtc_set_clock_offset() - Sets the clock's offset
* (usually relative to another clock).
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @offset: New clock offset (in nanoseconds).
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_set_clock_offset(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
int64_t offset)
{
struct dprtc_cmd_set_clock_offset *cmd_params;
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_SET_CLOCK_OFFSET,
cmd_flags,
token);
cmd_params = (struct dprtc_cmd_set_clock_offset *)cmd.params;
cmd_params->offset = cpu_to_le64(offset);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_set_freq_compensation() - Sets a new frequency compensation value.
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @freq_compensation: The new frequency compensation value to set.
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_set_freq_compensation(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint32_t freq_compensation)
{
struct dprtc_get_freq_compensation *cmd_params;
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_SET_FREQ_COMPENSATION,
cmd_flags,
token);
cmd_params = (struct dprtc_get_freq_compensation *)cmd.params;
cmd_params->freq_compensation = cpu_to_le32(freq_compensation);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_get_freq_compensation() - Retrieves the frequency compensation value
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @freq_compensation: Frequency compensation value
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_get_freq_compensation(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint32_t *freq_compensation)
{
struct dprtc_get_freq_compensation *rsp_params;
struct mc_command cmd = { 0 };
int err;
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_GET_FREQ_COMPENSATION,
cmd_flags,
token);
/* send command to mc*/
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
/* retrieve response parameters */
rsp_params = (struct dprtc_get_freq_compensation *)cmd.params;
*freq_compensation = le32_to_cpu(rsp_params->freq_compensation);
return 0;
}
/**
* dprtc_get_time() - Returns the current RTC time.
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @time: Current RTC time.
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_get_time(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint64_t *time)
{
struct dprtc_time *rsp_params;
struct mc_command cmd = { 0 };
int err;
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_GET_TIME,
cmd_flags,
token);
/* send command to mc*/
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
/* retrieve response parameters */
rsp_params = (struct dprtc_time *)cmd.params;
*time = le64_to_cpu(rsp_params->time);
return 0;
}
/**
* dprtc_set_time() - Updates current RTC time.
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @time: New RTC time.
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_set_time(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint64_t time)
{
struct dprtc_time *cmd_params;
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_SET_TIME,
cmd_flags,
token);
cmd_params = (struct dprtc_time *)cmd.params;
cmd_params->time = cpu_to_le64(time);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_set_alarm() - Defines and sets alarm.
*
* @mc_io: Pointer to MC portal's I/O object
* @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
* @token: Token of DPRTC object
* @time: In nanoseconds, the time when the alarm
* should go off - must be a multiple of
* 1 microsecond
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_set_alarm(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token, uint64_t time)
{
struct dprtc_time *cmd_params;
struct mc_command cmd = { 0 };
/* prepare command */
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_SET_ALARM,
cmd_flags,
token);
cmd_params = (struct dprtc_time *)cmd.params;
cmd_params->time = cpu_to_le64(time);
/* send command to mc*/
return mc_send_command(mc_io, &cmd);
}
/**
* dprtc_get_api_version() - Get Data Path Real Time Counter 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 real time counter API
* @minor_ver: Minor version of data path real time counter API
*
* Return: '0' on Success; Error code otherwise.
*/
int dprtc_get_api_version(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t *major_ver,
uint16_t *minor_ver)
{
struct dprtc_rsp_get_api_version *rsp_params;
struct mc_command cmd = { 0 };
int err;
cmd.header = mc_encode_cmd_header(DPRTC_CMDID_GET_API_VERSION,
cmd_flags,
0);
err = mc_send_command(mc_io, &cmd);
if (err)
return err;
rsp_params = (struct dprtc_rsp_get_api_version *)cmd.params;
*major_ver = le16_to_cpu(rsp_params->major);
*minor_ver = le16_to_cpu(rsp_params->minor);
return 0;
}

View File

@ -0,0 +1,109 @@
/* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
* Copyright 2019 NXP
*/
#ifndef __FSL_DPRTC_H
#define __FSL_DPRTC_H
/** @addtogroup dprtc Data Path Real Time Counter API
* Contains initialization APIs and runtime control APIs for RTC
* @{
*/
struct fsl_mc_io;
int dprtc_open(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
int dprtc_id,
uint16_t *token);
int dprtc_close(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token);
/**
* struct dprtc_cfg - Structure representing DPRTC configuration
* @options: place holder
*/
struct dprtc_cfg {
uint32_t options;
};
int dprtc_create(struct fsl_mc_io *mc_io,
uint16_t dprc_token,
uint32_t cmd_flags,
const struct dprtc_cfg *cfg,
uint32_t *obj_id);
int dprtc_destroy(struct fsl_mc_io *mc_io,
uint16_t dprc_token,
uint32_t cmd_flags,
uint32_t object_id);
int dprtc_enable(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token);
int dprtc_disable(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token);
int dprtc_is_enabled(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
int *en);
int dprtc_reset(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token);
int dprtc_set_clock_offset(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
int64_t offset);
int dprtc_set_freq_compensation(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint32_t freq_compensation);
int dprtc_get_freq_compensation(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint32_t *freq_compensation);
int dprtc_get_time(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint64_t *time);
int dprtc_set_time(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint64_t time);
int dprtc_set_alarm(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
uint64_t time);
/**
* struct dprtc_attr - Structure representing DPRTC attributes
* @id: DPRTC object ID
*/
struct dprtc_attr {
int id;
int paddr;
int little_endian;
};
int dprtc_get_attributes(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t token,
struct dprtc_attr *attr);
int dprtc_get_api_version(struct fsl_mc_io *mc_io,
uint32_t cmd_flags,
uint16_t *major_ver,
uint16_t *minor_ver);
#endif /* __FSL_DPRTC_H */

View File

@ -0,0 +1,91 @@
/* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
* Copyright 2019 NXP
*/
#include <fsl_mc_sys.h>
#ifndef _FSL_DPRTC_CMD_H
#define _FSL_DPRTC_CMD_H
/* DPRTC Version */
#define DPRTC_VER_MAJOR 2
#define DPRTC_VER_MINOR 1
/* Command versioning */
#define DPRTC_CMD_BASE_VERSION 1
#define DPRTC_CMD_ID_OFFSET 4
#define DPRTC_CMD(id) (((id) << DPRTC_CMD_ID_OFFSET) | DPRTC_CMD_BASE_VERSION)
/* Command IDs */
#define DPRTC_CMDID_CLOSE DPRTC_CMD(0x800)
#define DPRTC_CMDID_OPEN DPRTC_CMD(0x810)
#define DPRTC_CMDID_CREATE DPRTC_CMD(0x910)
#define DPRTC_CMDID_DESTROY DPRTC_CMD(0x990)
#define DPRTC_CMDID_GET_API_VERSION DPRTC_CMD(0xa10)
#define DPRTC_CMDID_ENABLE DPRTC_CMD(0x002)
#define DPRTC_CMDID_DISABLE DPRTC_CMD(0x003)
#define DPRTC_CMDID_GET_ATTR DPRTC_CMD(0x004)
#define DPRTC_CMDID_RESET DPRTC_CMD(0x005)
#define DPRTC_CMDID_IS_ENABLED DPRTC_CMD(0x006)
#define DPRTC_CMDID_SET_CLOCK_OFFSET DPRTC_CMD(0x1d0)
#define DPRTC_CMDID_SET_FREQ_COMPENSATION DPRTC_CMD(0x1d1)
#define DPRTC_CMDID_GET_FREQ_COMPENSATION DPRTC_CMD(0x1d2)
#define DPRTC_CMDID_GET_TIME DPRTC_CMD(0x1d3)
#define DPRTC_CMDID_SET_TIME DPRTC_CMD(0x1d4)
#define DPRTC_CMDID_SET_ALARM DPRTC_CMD(0x1d5)
#define DPRTC_CMDID_SET_PERIODIC_PULSE DPRTC_CMD(0x1d6)
#define DPRTC_CMDID_CLEAR_PERIODIC_PULSE DPRTC_CMD(0x1d7)
#define DPRTC_CMDID_SET_EXT_TRIGGER DPRTC_CMD(0x1d8)
#define DPRTC_CMDID_CLEAR_EXT_TRIGGER DPRTC_CMD(0x1d9)
#define DPRTC_CMDID_GET_EXT_TRIGGER_TIMESTAMP DPRTC_CMD(0x1dA)
/* Macros for accessing command fields smaller than 1byte */
#define DPRTC_MASK(field) \
GENMASK(DPRTC_##field##_SHIFT + DPRTC_##field##_SIZE - 1, \
DPRTC_##field##_SHIFT)
#define dprtc_get_field(var, field) \
(((var) & DPRTC_MASK(field)) >> DPRTC_##field##_SHIFT)
#pragma pack(push, 1)
struct dprtc_cmd_open {
uint32_t dprtc_id;
};
struct dprtc_cmd_destroy {
uint32_t object_id;
};
#define DPRTC_ENABLE_SHIFT 0
#define DPRTC_ENABLE_SIZE 1
#define DPRTC_ENDIANNESS_SHIFT 0
#define DPRTC_ENDIANNESS_SIZE 1
struct dprtc_rsp_is_enabled {
uint8_t en;
};
struct dprtc_rsp_get_attributes {
uint32_t paddr;
uint32_t id;
uint8_t little_endian;
};
struct dprtc_cmd_set_clock_offset {
uint64_t offset;
};
struct dprtc_get_freq_compensation {
uint32_t freq_compensation;
};
struct dprtc_time {
uint64_t time;
};
struct dprtc_rsp_get_api_version {
uint16_t major;
uint16_t minor;
};
#pragma pack(pop)
#endif /* _FSL_DPRTC_CMD_H */

View File

@ -18,6 +18,10 @@ sources = files('base/dpaa2_hw_dpni.c',
'mc/dpdmux.c',
'mc/dpni.c')
if dpdk_conf.has('RTE_LIBRTE_IEEE1588')
sources += files('mc/dprtc.c')
endif
includes += include_directories('base', 'mc')
# depends on fslmc bus which uses experimental API