staging: fsl-mc: add dpio driver
PATCH v4 1/8 bus: fsl-mc: dpio: add DPIO driver overview document
In reply to Stuart Yoderadd document describing the dpio driver and it's role, components and major interfaces
---
Notes:
-v4
-updated copyrightdrivers/staging/fsl-mc/bus/dpio/dpio-driver.txt | 135 ++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-driver.txt
drivers/staging/fsl-mc/bus/dpio/dpio-driver.txt new file +135 -0
@@ -0,0 +1,135 @@ +Copyright 2016 NXP + +Introduction +------------ + +A DPAA2 DPIO (Data Path I/O) is a hardware object that provides +interfaces to enqueue and dequeue frames to/from network interfaces +and other accelerators. A DPIO also provides hardware buffer +pool management for network interfaces. + +This document provides an overview the Linux DPIO driver, its +subcomponents, and its APIs. + +See Documentation/dpaa2/overview.txt for a general overview of DPAA2 +and the general DPAA2 driver architecture in Linux. + +Driver Overview +--------------- + +The DPIO driver is bound to DPIO objects discovered on the fsl-mc bus and +provides services that: + A) allow other drivers, such as the Ethernet driver, to enqueue and dequeue + frames for their respective objects + B) allow drivers to register callbacks for data availability notifications + when data becomes available on a queue or channel + C) allow drivers to manage hardware buffer pools + +The Linux DPIO driver consists of 3 primary components-- + DPIO object driver-- fsl-mc driver that manages the DPIO object + DPIO service-- provides APIs to other Linux drivers for services + QBman portal interface-- sends portal commands, gets responses + + fsl-mc other + bus drivers + | | + +---+----+ +------+-----+ + |DPIO obj| |DPIO service| + | driver |---| (DPIO) | + +--------+ +------+-----+ + | + +------+-----+ + | QBman | + | portal i/f | + +------------+ + | + hardware + +The diagram below shows how the DPIO driver components fit with the other +DPAA2 Linux driver components: + +------------+ + | OS Network | + | Stack | + +------------+ +------------+ + | Allocator |. . . . . . . | Ethernet | + |(DPMCP,DPBP)| | (DPNI) | + +-.----------+ +---+---+----+ + . . ^ | + . . <data avail, | |<enqueue, + . . tx confirm> | | dequeue> + +-------------+ . | | + | DPRC driver | . +--------+ +------------+ + | (DPRC) | . . |DPIO obj| |DPIO service| + +----------+--+ | driver |-| (DPIO) | + | +--------+ +------+-----+ + |<dev add/remove> +------|-----+ + | | QBman | + +----+--------------+ | portal i/f | + | MC-bus driver | +------------+ + | | | + | /soc/fsl-mc | | + +-------------------+ | + | + =========================================|=========|======================== + +-+--DPIO---|-----------+ + | | | + | QBman Portal | + +-----------------------+ + + ============================================================================ + + +DPIO Object Driver (dpio-driver.c) +---------------------------------- + + The dpio-driver component registers with the fsl-mc bus to handle objects of + type "dpio". The implementation of probe() handles basic initialization + of the DPIO including mapping of the DPIO regions (the QBman SW portal) + and initializing interrupts and registering irq handlers. The dpio-driver + registers the probed DPIO with dpio-service. + +DPIO service (dpio-service.c, dpaa2-io.h) +------------------------------------------ + + The dpio service component provides queuing, notification, and buffers + management services to DPAA2 drivers, such as the Ethernet driver. A system + will typically allocate 1 DPIO object per CPU to allow queuing operations + to happen simultaneously across all CPUs. + + Notification handling + dpaa2_io_service_register() + dpaa2_io_service_deregister() + dpaa2_io_service_rearm() + + Queuing + dpaa2_io_service_pull_fq() + dpaa2_io_service_pull_channel() + dpaa2_io_service_enqueue_fq() + dpaa2_io_service_enqueue_qd() + dpaa2_io_store_create() + dpaa2_io_store_destroy() + dpaa2_io_store_next() + + Buffer pool management + dpaa2_io_service_release() + dpaa2_io_service_acquire() + +QBman portal interface (qbman-portal.c) +--------------------------------------- + + The qbman-portal component provides APIs to do the low level hardware + bit twiddling for operations such as: + -initializing Qman software portals + -building and sending portal commands + -portal interrupt configuration and processing + + The qbman-portal APIs are not public to other drivers, and are + only used by dpio-service. + +Other (dpaa2-fd.h, dpaa2-global.h) +---------------------------------- + + Frame descriptor and scatter-gather definitions and the APIs used to + manipulate them are defined in dpaa2-fd.h. + + Dequeue result struct and parsing APIs are defined in dpaa2-global.h.
Signature · 1 line
1.9.0
PATCH v4 4/8 bus: fsl-mc: dpio: add global dpaa2 definitions
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
Create header for global dpaa2 definitions. Add definitions for dequeue results.
---
Notes:
-v4
-adjust file location to be in drivers/staging -whitespace/alignment cleanup, make dpaa2_dq_is_pull_complete()
return bool, fix spelling typo
-updated copyright
drivers/staging/fsl-mc/include/dpaa2-global.h | 202 ++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 drivers/staging/fsl-mc/include/dpaa2-global.h
drivers/staging/fsl-mc/include/dpaa2-global.h new file +202 -0
@@ -0,0 +1,202 @@ +/* +* Copyright 2014-2016 Freescale Semiconductor Inc. +* Copyright 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 Freescale Semiconductor nor the +* names of its 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 Freescale Semiconductor ``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 Freescale Semiconductor 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_DPAA2_GLOBAL_H +#define __FSL_DPAA2_GLOBAL_H + +#include <linux/types.h> +#include <linux/cpumask.h> +#include "dpaa2-fd.h" + +struct dpaa2_dq { +union { +struct common { +u8 verb; +u8 reserved[63 ]; + } common; +struct dq { +u8 verb; +u8 stat; +__le16 seqnum; +__le16 oprid; +u8 reserved; +u8 tok; +__le32 fqid; +u32 reserved2; +__le32 fq_byte_cnt; +__le32 fq_frm_cnt; +__le64 fqd_ctx; +u8 fd[32 ]; + } dq; +struct scn { +u8 verb; +u8 stat; +u8 state; +u8 reserved; +__le32 rid_tok; +__le64 ctx; + } scn; + }; +}; + +/* Parsing frame dequeue results */ +/* FQ empty */ +#define DPAA2_DQ_STAT_FQEMPTY 0x80 +/* FQ held active */ +#define DPAA2_DQ_STAT_HELDACTIVE 0x40 +/* FQ force eligible */ +#define DPAA2_DQ_STAT_FORCEELIGIBLE 0x20 +/* valid frame */ +#define DPAA2_DQ_STAT_VALIDFRAME 0x10 +/* FQ ODP enable */ +#define DPAA2_DQ_STAT_ODPVALID 0x04 +/* volatile dequeue */ +#define DPAA2_DQ_STAT_VOLATILE 0x02 +/* volatile dequeue command is expired */ +#define DPAA2_DQ_STAT_EXPIRED 0x01 + +#define DQ_FQID_MASK 0x00FFFFFF +#define DQ_FRAME_COUNT_MASK 0x00FFFFFF + +/** +* dpaa2_dq_flags() - Get the stat field of dequeue response +* @dq: the dequeue result. +*/ +static inline u32 dpaa2_dq_flags (const struct dpaa2_dq *dq) +{ +return dq->dq.stat; +} + +/** +* dpaa2_dq_is_pull() - Check whether the dq response is from a pull +* command. +* @dq: the dequeue result +* +* Return 1 for volatile(pull) dequeue, 0 for static dequeue. +*/ +static inline int dpaa2_dq_is_pull (const struct dpaa2_dq *dq) +{ +return (int )(dpaa2_dq_flags (dq) &DPAA2_DQ_STAT_VOLATILE ); +} + +/** +* dpaa2_dq_is_pull_complete() - Check whether the pull command is completed. +* @dq: the dequeue result +* +* Return boolean. +*/ +static inline bool dpaa2_dq_is_pull_complete (const struct dpaa2_dq *dq) +{ +return !!(dpaa2_dq_flags (dq) &DPAA2_DQ_STAT_EXPIRED ); +} + +/** +* dpaa2_dq_seqnum() - Get the seqnum field in dequeue response +* @dq: the dequeue result +* +* seqnum is valid only if VALIDFRAME flag is TRUE +* +* Return seqnum. +*/ +static inline u16 dpaa2_dq_seqnum (const struct dpaa2_dq *dq) +{ +return le16_to_cpu (dq->dq.seqnum); +} + +/** +* dpaa2_dq_odpid() - Get the odpid field in dequeue response +* @dq: the dequeue result +* +* odpid is valid only if ODPVALID flag is TRUE. +* +* Return odpid. +*/ +static inline u16 dpaa2_dq_odpid (const struct dpaa2_dq *dq) +{ +return le16_to_cpu (dq->dq.oprid); +} + +/** +* dpaa2_dq_fqid() - Get the fqid in dequeue response +* @dq: the dequeue result +* +* Return fqid. +*/ +static inline u32 dpaa2_dq_fqid (const struct dpaa2_dq *dq) +{ +return le32_to_cpu (dq->dq.fqid) &DQ_FQID_MASK ; +} + +/** +* dpaa2_dq_byte_count() - Get the byte count in dequeue response +* @dq: the dequeue result +* +* Return the byte count remaining in the FQ. +*/ +static inline u32 dpaa2_dq_byte_count (const struct dpaa2_dq *dq) +{ +return le32_to_cpu (dq->dq.fq_byte_cnt); +} + +/** +* dpaa2_dq_frame_count() - Get the frame count in dequeue response +* @dq: the dequeue result +* +* Return the frame count remaining in the FQ. +*/ +static inline u32 dpaa2_dq_frame_count (const struct dpaa2_dq *dq) +{ +return le32_to_cpu (dq->dq.fq_frm_cnt) &DQ_FRAME_COUNT_MASK ; +} + +/** +* dpaa2_dq_fd_ctx() - Get the frame queue context in dequeue response +* @dq: the dequeue result +* +* Return the frame queue context. +*/ +static inline u64 dpaa2_dq_fqd_ctx (const struct dpaa2_dq *dq) +{ +return le64_to_cpu (dq->dq.fqd_ctx); +} + +/** +* dpaa2_dq_fd() - Get the frame descriptor in dequeue response +* @dq: the dequeue result +* +* Return the frame descriptor. +*/ +static inline const struct dpaa2_fd *dpaa2_dq_fd (const struct dpaa2_dq *dq) +{ +return (const struct dpaa2_fd *)&dq->dq.fd[0 ]; +} + +#endif /* __FSL_DPAA2_GLOBAL_H */
Signature · 1 line
1.9.0
PATCH v4 3/8 bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
Add global definitions for DPAA2 frame descriptors and scatter gather entries.
---
Notes:
-v4
-updated copyright
-adjust file location to be in drivers/staging
-address cleanup comments-- whitespace cleanup, use !! consistently
to convert expression to bool, remove unneeded parenthesis
-v3
-no changes
-v2
-added setter/getter for the FD ctrl field
-corrected comment for SG format_offset field description -added support for short length field in FD
drivers/staging/fsl-mc/include/dpaa2-fd.h | 448 ++++++++++++++++++++++++++++++ 1 file changed, 448 insertions(+) create mode 100644 drivers/staging/fsl-mc/include/dpaa2-fd.h
drivers/staging/fsl-mc/include/dpaa2-fd.h new file +448 -0
@@ -0,0 +1,448 @@ +/* +* Copyright 2014-2016 Freescale Semiconductor Inc. +* Copyright 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 Freescale Semiconductor nor the +* names of its 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 Freescale Semiconductor ``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 Freescale Semiconductor 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_DPAA2_FD_H +#define __FSL_DPAA2_FD_H + +#include <linux/kernel.h> + +/** +* DOC: DPAA2 FD - Frame Descriptor APIs for DPAA2 +* +* Frame Descriptors (FDs) are used to describe frame data in the DPAA2. +* Frames can be enqueued and dequeued to Frame Queues (FQs) which are consumed +* by the various DPAA accelerators (WRIOP, SEC, PME, DCE) +* +* There are three types of frames: single, scatter gather, and frame lists. +* +* The set of APIs in this file must be used to create, manipulate and +* query Frame Descriptors. +*/ + +/** +* struct dpaa2_fd - Struct describing FDs +* @words: for easier/faster copying the whole FD structure +* @addr: address in the FD +* @len: length in the FD +* @bpid: buffer pool ID +* @format_offset: format, offset, and short-length fields +* @frc: frame context +* @ctrl: control bits...including dd, sc, va, err, etc +* @flc: flow context address +* +* This structure represents the basic Frame Descriptor used in the system. +*/ +struct dpaa2_fd { +union { +u32 words[8 ]; +struct dpaa2_fd_simple { +__le64 addr; +__le32 len; +__le16 bpid; +__le16 format_offset; +__le32 frc; +__le32 ctrl; +__le64 flc; + } simple; + }; +}; + +#define FD_SHORT_LEN_FLAG_MASK 0x1 +#define FD_SHORT_LEN_FLAG_SHIFT 14 +#define FD_SHORT_LEN_MASK 0x1FFFF +#define FD_OFFSET_MASK 0x0FFF +#define FD_FORMAT_MASK 0x3 +#define FD_FORMAT_SHIFT 12 +#define SG_SHORT_LEN_FLAG_MASK 0x1 +#define SG_SHORT_LEN_FLAG_SHIFT 14 +#define SG_SHORT_LEN_MASK 0x1FFFF +#define SG_OFFSET_MASK 0x0FFF +#define SG_FORMAT_MASK 0x3 +#define SG_FORMAT_SHIFT 12 +#define SG_BPID_MASK 0x3FFF +#define SG_FINAL_FLAG_MASK 0x1 +#define SG_FINAL_FLAG_SHIFT 15 + +enum dpaa2_fd_format { + dpaa2_fd_single =0 , + dpaa2_fd_list, + dpaa2_fd_sg +}; + +/** +* dpaa2_fd_get_addr() - get the addr field of frame descriptor +* @fd: the given frame descriptor +* +* Return the address in the frame descriptor. +*/ +static inline dma_addr_t dpaa2_fd_get_addr (const struct dpaa2_fd *fd) +{ +return (dma_addr_t )fd->simple.addr; +} + +/** +* dpaa2_fd_set_addr() - Set the addr field of frame descriptor +* @fd: the given frame descriptor +* @addr: the address needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_addr (struct dpaa2_fd *fd,dma_addr_t addr) +{ + fd->simple.addr = addr; +} + +/** +* dpaa2_fd_get_frc() - Get the frame context in the frame descriptor +* @fd: the given frame descriptor +* +* Return the frame context field in the frame descriptor. +*/ +static inline u32 dpaa2_fd_get_frc (const struct dpaa2_fd *fd) +{ +return fd->simple.frc; +} + +/** +* dpaa2_fd_set_frc() - Set the frame context in the frame descriptor +* @fd: the given frame descriptor +* @frc: the frame context needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_frc (struct dpaa2_fd *fd,u32 frc) +{ + fd->simple.frc = frc; +} + +/** +* dpaa2_fd_get_ctrl() - Get the control bits in the frame descriptor +* @fd: the given frame descriptor +* +* Return the control bits field in the frame descriptor. +*/ +static inline u32 dpaa2_fd_get_ctrl (const struct dpaa2_fd *fd) +{ +return fd->simple.ctrl; +} + +/** +* dpaa2_fd_set_ctrl() - Set the control bits in the frame descriptor +* @fd: the given frame descriptor +* @ctrl: the control bits to be set in the frame descriptor +*/ +static inline void dpaa2_fd_set_ctrl (struct dpaa2_fd *fd,u32 ctrl) +{ + fd->simple.ctrl = ctrl; +} + +/** +* dpaa2_fd_get_flc() - Get the flow context in the frame descriptor +* @fd: the given frame descriptor +* +* Return the flow context in the frame descriptor. +*/ +static inline dma_addr_t dpaa2_fd_get_flc (const struct dpaa2_fd *fd) +{ +return (dma_addr_t )fd->simple.flc; +} + +/** +* dpaa2_fd_set_flc() - Set the flow context field of frame descriptor +* @fd: the given frame descriptor +* @flc_addr: the flow context needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_flc (struct dpaa2_fd *fd,dma_addr_t flc_addr) +{ + fd->simple.flc = flc_addr; +} + +static inline bool dpaa2_fd_short_len (const struct dpaa2_fd *fd) +{ +return !!((fd->simple.format_offset >>FD_SHORT_LEN_FLAG_SHIFT ) + &FD_SHORT_LEN_FLAG_MASK ); +} + +/** +* dpaa2_fd_get_len() - Get the length in the frame descriptor +* @fd: the given frame descriptor +* +* Return the length field in the frame descriptor. +*/ +static inline u32 dpaa2_fd_get_len (const struct dpaa2_fd *fd) +{ +if (dpaa2_fd_short_len (fd)) +return fd->simple.len &FD_SHORT_LEN_MASK ; + +return fd->simple.len; +} + +/** +* dpaa2_fd_set_len() - Set the length field of frame descriptor +* @fd: the given frame descriptor +* @len: the length needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_len (struct dpaa2_fd *fd,u32 len) +{ + fd->simple.len = len; +} + +/** +* dpaa2_fd_get_offset() - Get the offset field in the frame descriptor +* @fd: the given frame descriptor +* +* Return the offset. +*/ +static inline uint16_t dpaa2_fd_get_offset (const struct dpaa2_fd *fd) +{ +return fd->simple.format_offset &FD_OFFSET_MASK ; +} + +/** +* dpaa2_fd_set_offset() - Set the offset field of frame descriptor +* @fd: the given frame descriptor +* @offset: the offset needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_offset (struct dpaa2_fd *fd,uint16_t offset) +{ + fd->simple.format_offset &= ~FD_OFFSET_MASK ; + fd->simple.format_offset |= offset; +} + +/** +* dpaa2_fd_get_format() - Get the format field in the frame descriptor +* @fd: the given frame descriptor +* +* Return the format. +*/ +static inline enum dpaa2_fd_format dpaa2_fd_get_format ( +const struct dpaa2_fd *fd) +{ +return (enum dpaa2_fd_format )((fd->simple.format_offset + >>FD_FORMAT_SHIFT ) &FD_FORMAT_MASK ); +} + +/** +* dpaa2_fd_set_format() - Set the format field of frame descriptor +* @fd: the given frame descriptor +* @format: the format needs to be set in frame descriptor +*/ +static inline void dpaa2_fd_set_format (struct dpaa2_fd *fd, +enum dpaa2_fd_format format) +{ + fd->simple.format_offset &= ~(FD_FORMAT_MASK <<FD_FORMAT_SHIFT ); + fd->simple.format_offset |= format <<FD_FORMAT_SHIFT ; +} + +/** +* dpaa2_fd_get_bpid() - Get the bpid field in the frame descriptor +* @fd: the given frame descriptor +* +* Return the buffer pool id. +*/ +static inline uint16_t dpaa2_fd_get_bpid (const struct dpaa2_fd *fd) +{ +return fd->simple.bpid; +} + +/** +* dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor +* @fd: the given frame descriptor +* @bpid: buffer pool id to be set +*/ +static inline void dpaa2_fd_set_bpid (struct dpaa2_fd *fd,uint16_t bpid) +{ + fd->simple.bpid = bpid; +} + +/** +* struct dpaa2_sg_entry - the scatter-gathering structure +* @addr: address of the sg entry +* @len: length in this sg entry +* @bpid: buffer pool id +* @format_offset: format and offset fields +*/ +struct dpaa2_sg_entry { +__le64 addr; +__le32 len; +__le16 bpid; +__le16 format_offset; +}; + +enum dpaa2_sg_format { + dpaa2_sg_single =0 , + dpaa2_sg_frame_data, + dpaa2_sg_sgt_ext +}; + +/* Accessors for SG entry fields */ + +/** +* dpaa2_sg_get_addr() - Get the address from SG entry +* @sg: the given scatter-gathering object +* +* Return the address. +*/ +static inline dma_addr_t dpaa2_sg_get_addr (const struct dpaa2_sg_entry *sg) +{ +return le64_to_cpu ((dma_addr_t )sg->addr); +} + +/** +* dpaa2_sg_set_addr() - Set the address in SG entry +* @sg: the given scatter-gathering object +* @addr: the address to be set +*/ +static inline void dpaa2_sg_set_addr (struct dpaa2_sg_entry *sg,dma_addr_t addr) +{ + sg->addr =cpu_to_le64 (addr); +} + +static inline bool dpaa2_sg_short_len (const struct dpaa2_sg_entry *sg) +{ +return !!((le16_to_cpu (sg->format_offset) >>SG_SHORT_LEN_FLAG_SHIFT ) + &SG_SHORT_LEN_FLAG_MASK ); +} + +/** +* dpaa2_sg_get_len() - Get the length in SG entry +* @sg: the given scatter-gathering object +* +* Return the length. +*/ +static inline u32 dpaa2_sg_get_len (const struct dpaa2_sg_entry *sg) +{ +if (dpaa2_sg_short_len (sg)) +return le32_to_cpu (sg->len) &SG_SHORT_LEN_MASK ; + +return le32_to_cpu (sg->len); +} + +/** +* dpaa2_sg_set_len() - Set the length in SG entry +* @sg: the given scatter-gathering object +* @len: the length to be set +*/ +static inline void dpaa2_sg_set_len (struct dpaa2_sg_entry *sg,u32 len) +{ + sg->len =cpu_to_le32 (len); +} + +/** +* dpaa2_sg_get_offset() - Get the offset in SG entry +* @sg: the given scatter-gathering object +* +* Return the offset. +*/ +static inline u16 dpaa2_sg_get_offset (const struct dpaa2_sg_entry *sg) +{ +return le16_to_cpu (sg->format_offset) &SG_OFFSET_MASK ; +} + +/** +* dpaa2_sg_set_offset() - Set the offset in SG entry +* @sg: the given scatter-gathering object +* @offset: the offset to be set +*/ +static inline void dpaa2_sg_set_offset (struct dpaa2_sg_entry *sg, +u16 offset) +{ + sg->format_offset &=cpu_to_le16 (~SG_OFFSET_MASK ); + sg->format_offset |=cpu_to_le16 (offset); +} + +/** +* dpaa2_sg_get_format() - Get the SG format in SG entry +* @sg: the given scatter-gathering object +* +* Return the format. +*/ +static inline enum dpaa2_sg_format +dpaa2_sg_get_format (const struct dpaa2_sg_entry *sg) +{ +return (enum dpaa2_sg_format )((le16_to_cpu (sg->format_offset) + >>SG_FORMAT_SHIFT ) &SG_FORMAT_MASK ); +} + +/** +* dpaa2_sg_set_format() - Set the SG format in SG entry +* @sg: the given scatter-gathering object +* @format: the format to be set +*/ +static inline void dpaa2_sg_set_format (struct dpaa2_sg_entry *sg, +enum dpaa2_sg_format format) +{ + sg->format_offset &=cpu_to_le16 (~(SG_FORMAT_MASK <<SG_FORMAT_SHIFT )); + sg->format_offset |=cpu_to_le16 (format <<SG_FORMAT_SHIFT ); +} + +/** +* dpaa2_sg_get_bpid() - Get the buffer pool id in SG entry +* @sg: the given scatter-gathering object +* +* Return the bpid. +*/ +static inline u16 dpaa2_sg_get_bpid (const struct dpaa2_sg_entry *sg) +{ +return le16_to_cpu (sg->bpid) &SG_BPID_MASK ; +} + +/** +* dpaa2_sg_set_bpid() - Set the buffer pool id in SG entry +* @sg: the given scatter-gathering object +* @bpid: the bpid to be set +*/ +static inline void dpaa2_sg_set_bpid (struct dpaa2_sg_entry *sg,u16 bpid) +{ + sg->bpid &=cpu_to_le16 (~(SG_BPID_MASK )); + sg->bpid |=cpu_to_le16 (bpid); +} + +/** +* dpaa2_sg_is_final() - Check final bit in SG entry +* @sg: the given scatter-gathering object +* +* Return bool. +*/ +static inline bool dpaa2_sg_is_final (const struct dpaa2_sg_entry *sg) +{ +return !!(le16_to_cpu (sg->format_offset) >>SG_FINAL_FLAG_SHIFT ); +} + +/** +* dpaa2_sg_set_final() - Set the final bit in SG entry +* @sg: the given scatter-gathering object +* @final: the final boolean to be set +*/ +static inline void dpaa2_sg_set_final (struct dpaa2_sg_entry *sg,bool final) +{ + sg->format_offset &=cpu_to_le16 (~(SG_FINAL_FLAG_MASK + <<SG_FINAL_FLAG_SHIFT )); + sg->format_offset |=cpu_to_le16 (final <<SG_FINAL_FLAG_SHIFT ); +} + +#endif /* __FSL_DPAA2_FD_H */
Signature · 1 line
1.9.0
PATCH v4 6/8 bus: fsl-mc: dpio: add the DPAA2 DPIO service interface
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
The DPIO service interface handles initialization of DPIO objects and exports APIs to be used by other DPAA2 object drivers to perform queuing and buffer management related operations. The service allows registration of callbacks when frames or notifications are received.
---
Notes:
-v4
-updated copyright
-adjust file location to be in drivers/staging -updated copyright
-added missing free on error path
-fixed typo in comment
-whitespace and alignment cleanup
-v3
-zero memory allocated for a dpio store (bug fix suggested
by Ioana Radulescu)
-v2
-use service_select_by_cpu() for re-arming DPIO interrupts -replace use of NR_CPUS with num_possible_cpus()
drivers/staging/fsl-mc/bus/dpio/Makefile | 2 +- drivers/staging/fsl-mc/bus/dpio/dpio-service.c | 616 +++++++++++++++++++++++++ drivers/staging/fsl-mc/include/dpaa2-io.h | 139 ++++++ 3 files changed, 756 insertions(+), 1 deletion(-) create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-service.c create mode 100644 drivers/staging/fsl-mc/include/dpaa2-io.h
drivers/staging/fsl-mc/bus/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o -fsl-mc-dpio-objs := dpio.o qbman-portal.o +fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
drivers/staging/fsl-mc/bus/dpio/dpio-service.c new file +616 -0
616 lines not on this page · raw message
drivers/staging/fsl-mc/include/dpaa2-io.h new file +139 -0
139 lines not on this page · raw message
Signature · 1 line
1.9.0
PATCH v4 2/8 bus: fsl-mc: dpio: add APIs for DPIO objects
In reply to Stuart YoderFrom: Ioana Radulescu <[email protected]>
Add the command build/parse APIs for operating on DPIO objects through the DPAA2 Management Complex.
---
Notes:
-v4
-adjust file location to be in drivers/staging -remove unneeded comments
-updated copyright
-v3
-no changes
-v2
-removed unused structs and defines
drivers/staging/fsl-mc/bus/Kconfig | 10 ++ drivers/staging/fsl-mc/bus/Makefile | 3 + drivers/staging/fsl-mc/bus/dpio/Makefile | 9 ++ drivers/staging/fsl-mc/bus/dpio/dpio-cmd.h | 76 ++++++++++ drivers/staging/fsl-mc/bus/dpio/dpio.c | 224 +++++++++++++++++++++++++++++ drivers/staging/fsl-mc/bus/dpio/dpio.h | 109 ++++++++++++++ 6 files changed, 431 insertions(+) create mode 100644 drivers/staging/fsl-mc/bus/dpio/Makefile create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-cmd.h create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio.h
drivers/staging/fsl-mc/bus/Kconfig +10 -0
@@ -15,3 +15,13 @@ config FSL_MC_BUS architecture. The fsl-mc bus driver handles discovery of DPAA2 objects (which are represented as Linux devices) and binding objects to drivers. + +config FSL_MC_DPIO + tristate "QorIQ DPAA2 DPIO driver" + depends on FSL_MC_BUS + help + Driver for the DPAA2 DPIO object. A DPIO provides queue and + buffer management facilities for software to interact with + other DPAA2 objects. This driver does not expose the DPIO + objects individually, but groups them under a service layer + API.
drivers/staging/fsl-mc/bus/Makefile +3 -0
@@ -18,3 +18,6 @@ mc-bus-driver-objs := fsl-mc-bus.o \ irq-gic-v3-its-fsl-mc-msi.o \ dpmcp.o \ dpbp.o + +# MC DPIO driver +obj-$(CONFIG_FSL_MC_DPIO) += dpio/
drivers/staging/fsl-mc/bus/dpio/Makefile new file +9 -0
@@ -0,0 +1,9 @@ +# +# QorIQ DPAA2 DPIO driver +# + +subdir-ccflags-y := -Werror + +obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o + +fsl-mc-dpio-objs := dpio.o
drivers/staging/fsl-mc/bus/dpio/dpio-cmd.h new file +76 -0
76 lines not on this page · raw message
drivers/staging/fsl-mc/bus/dpio/dpio.c new file +224 -0
224 lines not on this page · raw message
drivers/staging/fsl-mc/bus/dpio/dpio.h new file +109 -0
109 lines not on this page · raw message
Signature · 1 line
1.9.0
PATCH v4 8/8 bus: fsl-mc: dpio: add maintainer for DPIO
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
add Roy Pledge as maintainer of DPIO
---
Notes:
-v4
-adjust file location to be in drivers/staging
-v3
-no changes
-v2
-corrected location of maintainer entryMAINTAINERS | 6 ++++++ 1 file changed, 6 insertions(+)
MAINTAINERS +6 -0
@@ -3980,6 +3980,12 @@ S: Maintained F: drivers/char/dtlk.c F: include/linux/dtlk.h +DPAA2 DATAPATH I/O (DPIO) DRIVER +M: Roy Pledge <[email protected]> +L: [email protected] +S: Maintained +F: drivers/staging/fsl-mc/bus/dpio + DPT_I2O SCSI RAID DRIVER M: Adaptec OEM Raid Solutions <[email protected]> L: [email protected]
Signature · 1 line
1.9.0
PATCH v4 7/8 bus: fsl-mc: dpio: add the DPAA2 DPIO object driver
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
The DPIO driver registers with the fsl-mc bus to handle bus-related events for DPIO objects. Key responsibility is mapping I/O regions, setting up interrupt handlers, and calling the DPIO service initialization during probe.
---
Notes:
-v4
-updated copyright
-adjust file location to be in drivers/staging -whitespace alignment cleanup
-v3
-no changes
-v2
-handle error case where number of DPIOs > NR_CPUs
drivers/staging/fsl-mc/bus/dpio/Makefile | 2 +- drivers/staging/fsl-mc/bus/dpio/dpio-driver.c | 296 ++++++++++++++++++++++++++ 2 files changed, 297 insertions(+), 1 deletion(-) create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-driver.c
drivers/staging/fsl-mc/bus/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o -fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o +fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o dpio-driver.o
drivers/staging/fsl-mc/bus/dpio/dpio-driver.c new file +296 -0
296 lines not on this page · raw message
Signature · 1 line
1.9.0
PATCH v4 5/8 bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2
In reply to Stuart YoderFrom: Roy Pledge <[email protected]>
Add QBman APIs for frame queue and buffer pool operations.
---
Notes:
-v4
-adjust file location to be in drivers/staging -updated copyright
-added definition for static dequeue token value -fixed bug in SDQCR #define
-added missing #include guard in qbman-portal.h -added #define for QMAN_REV_MASK
-whitespace, alignment cleanup
-v3
-replace hardcoded dequeue token with a #define and check that
token when checking for a new result (bug fix suggested by Ioana Radulescu)
-v2
-fix bug in buffer release command, by setting bpid field -handle error (NULL) return value from qbman_swp_mc_complete() -error message cleanup
-fix bug in sending management commands where the verb was
properly initialized
drivers/staging/fsl-mc/bus/dpio/Makefile | 2 +- drivers/staging/fsl-mc/bus/dpio/qbman-portal.c | 1033 ++++++++++++++++++++++++ drivers/staging/fsl-mc/bus/dpio/qbman-portal.h | 469 +++++++++++ 3 files changed, 1503 insertions(+), 1 deletion(-) create mode 100644 drivers/staging/fsl-mc/bus/dpio/qbman-portal.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/qbman-portal.h
drivers/staging/fsl-mc/bus/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o -fsl-mc-dpio-objs := dpio.o +fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/staging/fsl-mc/bus/dpio/qbman-portal.c new file +1033 -0
1,033 lines not on this page · raw message
drivers/staging/fsl-mc/bus/dpio/qbman-portal.h new file +469 -0
469 lines not on this page · raw message
Signature · 1 line
1.9.0
v4 cover staging: fsl-mc: add dpio driver
This patch series adds the driver for the DPIO object which is a step to addressing the final item in the staging TODO list-- adding a functional driver on top of the bus driver. The DPIO driver is a dependency for other functional drivers such as Ethernet.
An overview of the DPIO object and driver components are in patch 1. Patches 2-6 are internal components of the DPIO driver-- bit twiddling of hardware registers, DPAA2 data structures, and the queuing APIs exposed to other drivers.
Patch 7 adds the fsl-mc driver for the DPIO object. It provides the probe/remove functions, demonstrating a working example of how fsl-mc drivers initialize, interact with the management complex hardware, map their mappable MMIO regions, initialize interrupts, register an ISR, etc. All other DPAA2 drivers will follow a similar initialization pattern.
version 4 changes
-removed the patch moving the bus driver out of staging, updated
all paths referenced in dpio (e.g. includes) to be drivers/staging
-defined macros for constants where needed
-copyright updates
-cleanup: fixed whitespace, alignment issues, typos, removed unneeded
comments
-fixed bug in SDQCR #define
-adding missing free in an error path
version 3 changes
-zero memory allocated for a dpio store
-replace hardcoded dequeue token with a #define and look for
that token when checking for a new result
version 2 changes (mostly feedback from Ioana Radulescu)
-removed unused structs and defines in dpio command definitions -added setter/getter for the FD ctrl field
-corrected comment for SG format_offset field description -added support for short length field in FD
-fix bug in buffer release command, by setting bpid field -handle error (NULL) return value from qbman_swp_mc_complete() -fix bug in sending management commands where the verb was
properly initialized
-use service_select_by_cpu() for re-arming DPIO interrupts -replace use of NR_CPUS with num_possible_cpus()
-handle error case where number of DPIOs exceeds number of possible
CPUs
-error message cleanup
-updated MAINTAINERS file with proper location for both fsl-mc bus
driver and dpio driver
Ioana Radulescu (1):
bus: fsl-mc: dpio: add APIs for DPIO objects
Roy Pledge (6):
bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs
bus: fsl-mc: dpio: add global dpaa2 definitions
bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2
bus: fsl-mc: dpio: add the DPAA2 DPIO service interface
bus: fsl-mc: dpio: add the DPAA2 DPIO object driver
bus: fsl-mc: dpio: add maintainer for DPIO
Stuart Yoder (1):
bus: fsl-mc: dpio: add DPIO driver overview document
MAINTAINERS | 6 + drivers/staging/fsl-mc/bus/Kconfig | 10 + drivers/staging/fsl-mc/bus/Makefile | 3 + drivers/staging/fsl-mc/bus/dpio/Makefile | 9 + drivers/staging/fsl-mc/bus/dpio/dpio-cmd.h | 76 ++ drivers/staging/fsl-mc/bus/dpio/dpio-driver.c | 296 +++++++ drivers/staging/fsl-mc/bus/dpio/dpio-driver.txt | 135 +++ drivers/staging/fsl-mc/bus/dpio/dpio-service.c | 616 ++++++++++++++ drivers/staging/fsl-mc/bus/dpio/dpio.c | 224 +++++ drivers/staging/fsl-mc/bus/dpio/dpio.h | 109 +++ drivers/staging/fsl-mc/bus/dpio/qbman-portal.c | 1033 +++++++++++++++++++++++ drivers/staging/fsl-mc/bus/dpio/qbman-portal.h | 469 ++++++++++ drivers/staging/fsl-mc/include/dpaa2-fd.h | 448 ++++++++++ drivers/staging/fsl-mc/include/dpaa2-global.h | 202 +++++ drivers/staging/fsl-mc/include/dpaa2-io.h | 139 +++ 15 files changed, 3775 insertions(+) create mode 100644 drivers/staging/fsl-mc/bus/dpio/Makefile create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-cmd.h create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-driver.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-driver.txt create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio-service.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/dpio.h create mode 100644 drivers/staging/fsl-mc/bus/dpio/qbman-portal.c create mode 100644 drivers/staging/fsl-mc/bus/dpio/qbman-portal.h create mode 100644 drivers/staging/fsl-mc/include/dpaa2-fd.h create mode 100644 drivers/staging/fsl-mc/include/dpaa2-global.h create mode 100644 drivers/staging/fsl-mc/include/dpaa2-io.h
Signature · 1 line
1.9.0
kbuild test robot
build botRe: [PATCH v4 5/8] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2
In reply to Stuart Yoderurl: https://github.com/0day-ci/linux/commits/Stuart-Yoder/staging-fsl-mc-add-dpio-driver/20161216-114620 config: arm64-allmodconfig (attached as .config) compiler: aarch64-linux-gnu-gcc (Debian…
Hi Roy,
[auto build test ERROR on staging/staging-testing]
[also build test ERROR on next-20161215]
[cannot apply to v4.9]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]
url: https://github.com/0day-ci/linux/commits/Stuart-Yoder/staging-fsl-mc-add-dpio-driver/20161216-114620
config: arm64-allmodconfig (attached as .config)
compiler: aarch64-linux-gnu-gcc (Debian 6.1.1-9) 6.1.1 20160705
reproduce:
wget https://git.kernel.org/cgit/linux/kernel/git/wfg/lkp-tests.git/plain/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
make.cross ARCH=arm64
All errors (new ones prefixed by >>):
>> drivers/staging/fsl-mc/bus/dpio/qbman-portal.c:996:10: error: expected declaration specifiers or '...' before numeric constant
64 ctx)
^~vim +996 drivers/staging/fsl-mc/bus/dpio/qbman-portal.c
990 u16 ch;
991 u8 reserved[60];
992 };
993
994 int qbman_swp_CDAN_set(struct qbman_swp *s, u16 channelid,
995 u8 we_mask, u8 cdan_en,
> 996 64 ctx)
997 {
998 struct qbman_cdan_ctrl_desc *p = NULL;
999 struct qbman_cdan_ctrl_rslt *r = NULL;
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
RE: [PATCH v4 5/8] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2
Quoted 52 lines
-----Original Message-----
From: kbuild test robot [mailto:[email protected]]
Sent: Friday, December 16, 2016 1:57 AM
To: Stuart Yoder <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; Haiying Wang <[email protected]>; Roy Pledge <[email protected]>; linux- [email protected]; Leo Li <[email protected]>; Catalin Horghidan <[email protected]>; Ioana Ciornei <[email protected]>; Stuart Yoder <[email protected]>; Laurentiu Tudor <[email protected]>
Subject: Re: [PATCH v4 5/8] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2Hi Roy,
[auto build test ERROR on staging/staging-testing]
[also build test ERROR on next-20161215]
[cannot apply to v4.9]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system]url: https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2F0day-
ci%2Flinux%2Fcommits%2FStuart-Yoder%2Fstaging-fsl-mc-add-dpio-driver%2F20161216- 114620&data=01%7C01%7Cstuart.yoder%40nxp.com%7C0eec622fda6c4ba7b20808d425893386%7C686ea1d3bc2b4c6fa92cd9 9c5c301635%7C0&sdata=3DcsmOyC%2FMv%2B8A1n%2Fzq%2FWIxSsP3EjA%2F2XLyKTkvbRSA%3D&reserved=0
config: arm64-allmodconfig (attached as .config)
compiler: aarch64-linux-gnu-gcc (Debian 6.1.1-9) 6.1.1 20160705
reproduce:
wget
https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgit.kernel.org%2Fcgit%2Flinux%2Fkerne
l%2Fgit%2Fwfg%2Flkp- tests.git%2Fplain%2Fsbin%2Fmake.cross&data=01%7C01%7Cstuart.yoder%40nxp.com%7C0eec622fda6c4ba7b20808d425 893386%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0&sdata=tKbhJjq7jjDBYPLhMB%2FfnR1t%2BKEffwh8mZb7leKtxF4%3D&r eserved=0 -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# save the attached .config to linux build tree
make.cross ARCH=arm64All errors (new ones prefixed by >>):
Quoted 1 line
Quoted 1 line
drivers/staging/fsl-mc/bus/dpio/qbman-portal.c:996:10: error: expected declaration specifiers or'...' before numeric constant
64 ctx) ^~vim +996
drivers/staging/fsl-mc/bus/dpio/qbman-portal.c990 u16 ch; 991 u8 reserved[60]; 992 }; 993 994 int qbman_swp_CDAN_set(struct qbman_swp *s, u16 channelid, 995 u8 we_mask, u8 cdan_en,
Quoted 4 lines
Quoted 1 line
996 64 ctx)
997 { 998 struct qbman_cdan_ctrl_desc *p = NULL; 999 struct qbman_cdan_ctrl_rslt *r = NULL;
Ugh...made a last minute fix to the alignment and made a typo, and while I could have sworn I recompiled everything I obviously didn't. Will respin.
Stuart