/* Copyright 2013-2015 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_DPBP_H #define __FSL_DPBP_H /* Data Path Buffer Pool API * Contains initialization APIs and runtime control APIs for DPBP */ struct fsl_mc_io; int dpbp_open(struct fsl_mc_io *mc_io, u32 cmd_flags, int dpbp_id, u16 *token); int dpbp_close(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); /** * struct dpbp_cfg - Structure representing DPBP configuration * @options: place holder */ struct dpbp_cfg { u32 options; }; int dpbp_create(struct fsl_mc_io *mc_io, u32 cmd_flags, const struct dpbp_cfg *cfg, u16 *token); int dpbp_destroy(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); int dpbp_enable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); int dpbp_disable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); int dpbp_is_enabled(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, int *en); int dpbp_reset(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); /** * struct dpbp_irq_cfg - IRQ configuration * @addr: Address that must be written to signal a message-based interrupt * @val: Value to write into irq_addr address * @irq_num: A user defined number associated with this IRQ */ struct dpbp_irq_cfg { u64 addr; u32 val; int irq_num; }; int dpbp_set_irq(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, struct dpbp_irq_cfg *irq_cfg); int dpbp_get_irq(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, int *type, struct dpbp_irq_cfg *irq_cfg); int dpbp_set_irq_enable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u8 en); int dpbp_get_irq_enable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u8 *en); int dpbp_set_irq_mask(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 mask); int dpbp_get_irq_mask(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 *mask); int dpbp_get_irq_status(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 *status); int dpbp_clear_irq_status(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 status); /** * struct dpbp_attr - Structure representing DPBP attributes * @id: DPBP object ID * @version: DPBP version * @bpid: Hardware buffer pool ID; should be used as an argument in * acquire/release operations on buffers */ struct dpbp_attr { int id; /** * struct version - Structure representing DPBP version * @major: DPBP major version * @minor: DPBP minor version */ struct { u16 major; u16 minor; } version; u16 bpid; }; int dpbp_get_attributes(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, struct dpbp_attr *attr); /** * DPBP notifications options */ /** * BPSCN write will attempt to allocate into a cache (coherent write) */ #define DPBP_NOTIF_OPT_COHERENT_WRITE 0x00000001 /** * struct dpbp_notification_cfg - Structure representing DPBP notifications * towards software * @depletion_entry: below this threshold the pool is "depleted"; * set it to '0' to disable it * @depletion_exit: greater than or equal to this threshold the pool exit its * "depleted" state * @surplus_entry: above this threshold the pool is in "surplus" state; * set it to '0' to disable it * @surplus_exit: less than or equal to this threshold the pool exit its * "surplus" state * @message_iova: MUST be given if either 'depletion_entry' or 'surplus_entry' * is not '0' (enable); I/O virtual address (must be in DMA-able memory), * must be 16B aligned. * @message_ctx: The context that will be part of the BPSCN message and will * be written to 'message_iova' * @options: Mask of available options; use 'DPBP_NOTIF_OPT_' values */ struct dpbp_notification_cfg { u32 depletion_entry; u32 depletion_exit; u32 surplus_entry; u32 surplus_exit; u64 message_iova; u64 message_ctx; u16 options; }; int dpbp_set_notifications(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, struct dpbp_notification_cfg *cfg); int dpbp_get_notifications(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, struct dpbp_notification_cfg *cfg); /** @} */ #endif /* __FSL_DPBP_H */