drivers/bus/fslmc/mc/fsl_dpbp.h

   1 /*-
   2  * This file is provided under a dual BSD/GPLv2 license. When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  *   BSD LICENSE
   6  *
   7  * Copyright 2013-2016 Freescale Semiconductor Inc.
   8  * Copyright 2016-2017 NXP.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  * * Redistributions of source code must retain the above copyright
  13  * notice, this list of conditions and the following disclaimer.
  14  * * Redistributions in binary form must reproduce the above copyright
  15  * notice, this list of conditions and the following disclaimer in the
  16  * documentation and/or other materials provided with the distribution.
  17  * * Neither the name of the above-listed copyright holders nor the
  18  * names of any contributors may be used to endorse or promote products
  19  * derived from this software without specific prior written permission.
  20  *
  21  *   GPL LICENSE SUMMARY
  22  *
  23  * ALTERNATIVELY, this software may be distributed under the terms of the
  24  * GNU General Public License ("GPL") as published by the Free Software
  25  * Foundation, either version 2 of that License or (at your option) any
  26  * later version.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  29  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  32  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  */
  40 #ifndef __FSL_DPBP_H
  41 #define __FSL_DPBP_H
  42
  43 /*
  44  * Data Path Buffer Pool API
  45  * Contains initialization APIs and runtime control APIs for DPBP
  46  */
  47
  48 struct fsl_mc_io;
  49
  50 int dpbp_open(struct fsl_mc_io *mc_io,
  51               uint32_t cmd_flags,
  52               int dpbp_id,
  53               uint16_t *token);
  54
  55 int dpbp_close(struct fsl_mc_io *mc_io,
  56                uint32_t cmd_flags,
  57                uint16_t token);
  58
  59 /**
  60  * struct dpbp_cfg - Structure representing DPBP configuration
  61  * @options:    place holder
  62  */
  63 struct dpbp_cfg {
  64         uint32_t options;
  65 };
  66
  67 int dpbp_create(struct fsl_mc_io *mc_io,
  68                 uint16_t dprc_token,
  69                 uint32_t cmd_flags,
  70                 const struct dpbp_cfg *cfg,
  71                 uint32_t *obj_id);
  72
  73 int dpbp_destroy(struct fsl_mc_io *mc_io,
  74                  uint16_t dprc_token,
  75                  uint32_t cmd_flags,
  76                  uint32_t obj_id);
  77
  78 int dpbp_enable(struct fsl_mc_io *mc_io,
  79                 uint32_t cmd_flags,
  80                 uint16_t token);
  81
  82 int dpbp_disable(struct fsl_mc_io *mc_io,
  83                  uint32_t cmd_flags,
  84                  uint16_t token);
  85
  86 int dpbp_is_enabled(struct fsl_mc_io *mc_io,
  87                     uint32_t cmd_flags,
  88                     uint16_t token,
  89                     int *en);
  90
  91 int dpbp_reset(struct fsl_mc_io *mc_io,
  92                uint32_t cmd_flags,
  93                uint16_t token);
  94
  95 /**
  96  * struct dpbp_attr - Structure representing DPBP attributes
  97  * @id:         DPBP object ID
  98  * @bpid:       Hardware buffer pool ID; should be used as an argument in
  99  *              acquire/release operations on buffers
 100  */
 101 struct dpbp_attr {
 102         int id;
 103         uint16_t bpid;
 104 };
 105
 106 int dpbp_get_attributes(struct fsl_mc_io *mc_io,
 107                         uint32_t cmd_flags,
 108                         uint16_t token,
 109                         struct dpbp_attr *attr);
 110
 111 /**
 112  *  DPBP notifications options
 113  */
 114
 115 /**
 116  * BPSCN write will attempt to allocate into a cache (coherent write)
 117  */
 118 int dpbp_get_api_version(struct fsl_mc_io *mc_io,
 119                          uint32_t cmd_flags,
 120                          uint16_t *major_ver,
 121                          uint16_t *minor_ver);
 122
 123 int dpbp_get_num_free_bufs(struct fsl_mc_io *mc_io,
 124                            uint32_t cmd_flags,
 125                            uint16_t token,
 126                            uint32_t *num_free_bufs);
 127
 128 #endif /* __FSL_DPBP_H */