drivers/bus/dpaa/include/fsl_usd.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 2010-2011 Freescale Semiconductor, Inc.
   8  * All rights reserved.
   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
  41 #ifndef __FSL_USD_H
  42 #define __FSL_USD_H
  43
  44 #include <compat.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /* Thread-entry/exit hooks; */
  51 int qman_thread_init(void);
  52 int qman_thread_finish(void);
  53
  54 #define QBMAN_ANY_PORTAL_IDX 0xffffffff
  55
  56 /* Obtain and free raw (unitialized) portals */
  57
  58 struct dpaa_raw_portal {
  59         /* inputs */
  60
  61         /* set to non zero to turn on stashing */
  62         uint8_t enable_stash;
  63         /* Stashing attributes for the portal */
  64         uint32_t cpu;
  65         uint32_t cache;
  66         uint32_t window;
  67
  68         /* Specifies the stash request queue this portal should use */
  69         uint8_t sdest;
  70
  71         /* Specifes a specific portal index to map or QBMAN_ANY_PORTAL_IDX
  72          * for don't care.  The portal index will be populated by the
  73          * driver when the ioctl() successfully completes.
  74          */
  75         uint32_t index;
  76
  77         /* outputs */
  78         uint64_t cinh;
  79         uint64_t cena;
  80 };
  81
  82 int qman_allocate_raw_portal(struct dpaa_raw_portal *portal);
  83 int qman_free_raw_portal(struct dpaa_raw_portal *portal);
  84
  85 int bman_allocate_raw_portal(struct dpaa_raw_portal *portal);
  86 int bman_free_raw_portal(struct dpaa_raw_portal *portal);
  87
  88 /* Post-process interrupts. NB, the kernel IRQ handler disables the interrupt
  89  * line before notifying us, and this post-processing re-enables it once
  90  * processing is complete. As such, it is essential to call this before going
  91  * into another blocking read/select/poll.
  92  */
  93 void qman_thread_irq(void);
  94
  95 /* Global setup */
  96 int qman_global_init(void);
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif /* __FSL_USD_H */