[dpdk-dev] [PATCH v5 03/12] crypto/dpaa2_sec: add mc dpseci object support

De Lara Guarch, Pablo pablo.de.lara.guarch at intel.com
Tue Mar 21 17:00:16 CET 2017



> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal at nxp.com]
> Sent: Friday, March 03, 2017 7:49 PM
> To: dev at dpdk.org
> Cc: thomas.monjalon at 6wind.com; Doherty, Declan; De Lara Guarch, Pablo;
> Mcnamara, John; nhorman at tuxdriver.com; hemant.agrawal at nxp.com;
> Akhil Goyal; Cristian Sovaiala
> Subject: [PATCH v5 03/12] crypto/dpaa2_sec: add mc dpseci object support
> 
> add support for dpseci object in MC driver.
> DPSECI represent a crypto object in DPAA2.
> 
> Signed-off-by: Cristian Sovaiala <cristian.sovaiala at nxp.com>
> Signed-off-by: Akhil Goyal <akhil.goyal at nxp.com>
> ---
...

> diff --git a/drivers/crypto/dpaa2_sec/mc/dpseci.c
> b/drivers/crypto/dpaa2_sec/mc/dpseci.c
> new file mode 100644
> index 0000000..173a40c
> --- /dev/null
> +++ b/drivers/crypto/dpaa2_sec/mc/dpseci.c
> @@ -0,0 +1,527 @@
> +/* Copyright 2013-2016 Freescale Semiconductor Inc.
> + * Copyright (c) 2016 NXP.
> + *
> + * 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.
> + */

Blank line here. Make this change in the rest of the file (and possibly other files).

> +#include <fsl_mc_sys.h>
> +#include <fsl_mc_cmd.h>
> +#include <fsl_dpseci.h>
> +#include <fsl_dpseci_cmd.h>
> +
> +int dpseci_open(struct fsl_mc_io *mc_io,

Return type goes in a separate line. Make this change in the rest of the file (and possibly other files).

> +		uint32_t cmd_flags,
> +		int dpseci_id,
> +		uint16_t *token)
> +{
> +	struct mc_command cmd = { 0 };
> +	int err;
> +
> +	/* prepare command */
> +	cmd.header = mc_encode_cmd_header(DPSECI_CMDID_OPEN,
> +					  cmd_flags,
> +					  0);
> +	DPSECI_CMD_OPEN(cmd, dpseci_id);
> +
> +	/* send command to mc*/

Extra space before *, and remove it after it. Make this change in the rest of the file (and possibly other files).

> +	err = mc_send_command(mc_io, &cmd);
> +	if (err)
> +		return err;
> +
> +	/* retrieve response parameters */
> +	*token = MC_CMD_HDR_READ_TOKEN(cmd.header);
> +
> +	return 0;
> +}
> +
> +int dpseci_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(DPSECI_CMDID_CLOSE,
> +					  cmd_flags,
> +					  token);
> +
> +	/* send command to mc*/
> +	return mc_send_command(mc_io, &cmd);
> +}
> +
> +int dpseci_create(struct fsl_mc_io	*mc_io,
> +		  uint16_t	dprc_token,
> +		  uint32_t	cmd_flags,
> +		  const struct dpseci_cfg	*cfg,
> +		  uint32_t	*obj_id)

Indentation looks weird here. Remove the tabs between the variable type and name or indent all at the same level.
Make this change in the rest of the file (and possibly other files).

...

> diff --git a/drivers/crypto/dpaa2_sec/mc/fsl_dpseci.h
> b/drivers/crypto/dpaa2_sec/mc/fsl_dpseci.h
> new file mode 100644
> index 0000000..644e30c
> --- /dev/null
> +++ b/drivers/crypto/dpaa2_sec/mc/fsl_dpseci.h
> @@ -0,0 +1,661 @@

...

> +/**
> + * dpseci_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_'
> + * @dpseci_id:	DPSECI 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 dpseci_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.
> + */

Even though this is not a public function (at least, that's what I think),
You should follow the standard way to include function comments, using @param and @return.
Look at other header files.




More information about the dev mailing list