drivers/bus/fslmc/mc/fsl_dpbp_cmd.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_CMD_H
  41 #define _FSL_DPBP_CMD_H
  42
  43 /* DPBP Version */
  44 #define DPBP_VER_MAJOR                          3
  45 #define DPBP_VER_MINOR                          3
  46
  47 /* Command versioning */
  48 #define DPBP_CMD_BASE_VERSION                   1
  49 #define DPBP_CMD_ID_OFFSET                      4
  50
  51 #define DPBP_CMD(id)    ((id << DPBP_CMD_ID_OFFSET) | DPBP_CMD_BASE_VERSION)
  52
  53 /* Command IDs */
  54 #define DPBP_CMDID_CLOSE                DPBP_CMD(0x800)
  55 #define DPBP_CMDID_OPEN                 DPBP_CMD(0x804)
  56 #define DPBP_CMDID_CREATE               DPBP_CMD(0x904)
  57 #define DPBP_CMDID_DESTROY              DPBP_CMD(0x984)
  58 #define DPBP_CMDID_GET_API_VERSION      DPBP_CMD(0xa04)
  59
  60 #define DPBP_CMDID_ENABLE               DPBP_CMD(0x002)
  61 #define DPBP_CMDID_DISABLE              DPBP_CMD(0x003)
  62 #define DPBP_CMDID_GET_ATTR             DPBP_CMD(0x004)
  63 #define DPBP_CMDID_RESET                DPBP_CMD(0x005)
  64 #define DPBP_CMDID_IS_ENABLED           DPBP_CMD(0x006)
  65
  66 #define DPBP_CMDID_SET_IRQ_ENABLE       DPBP_CMD(0x012)
  67 #define DPBP_CMDID_GET_IRQ_ENABLE       DPBP_CMD(0x013)
  68 #define DPBP_CMDID_SET_IRQ_MASK         DPBP_CMD(0x014)
  69 #define DPBP_CMDID_GET_IRQ_MASK         DPBP_CMD(0x015)
  70 #define DPBP_CMDID_GET_IRQ_STATUS       DPBP_CMD(0x016)
  71 #define DPBP_CMDID_CLEAR_IRQ_STATUS     DPBP_CMD(0x017)
  72
  73 #define DPBP_CMDID_SET_NOTIFICATIONS    DPBP_CMD(0x1b0)
  74 #define DPBP_CMDID_GET_NOTIFICATIONS    DPBP_CMD(0x1b1)
  75
  76 #define DPBP_CMDID_GET_FREE_BUFFERS_NUM DPBP_CMD(0x1b2)
  77
  78 #pragma pack(push, 1)
  79 struct dpbp_cmd_open {
  80         uint32_t dpbp_id;
  81 };
  82
  83 struct dpbp_cmd_destroy {
  84         uint32_t object_id;
  85 };
  86
  87 #define DPBP_ENABLE                     0x1
  88
  89 struct dpbp_rsp_is_enabled {
  90         uint8_t enabled;
  91 };
  92
  93 struct dpbp_rsp_get_attributes {
  94         uint16_t pad;
  95         uint16_t bpid;
  96         uint32_t id;
  97 };
  98
  99 struct dpbp_cmd_set_notifications {
 100         uint32_t depletion_entry;
 101         uint32_t depletion_exit;
 102         uint32_t surplus_entry;
 103         uint32_t surplus_exit;
 104         uint16_t options;
 105         uint16_t pad[3];
 106         uint64_t message_ctx;
 107         uint64_t message_iova;
 108 };
 109
 110 struct dpbp_rsp_get_notifications {
 111         uint32_t depletion_entry;
 112         uint32_t depletion_exit;
 113         uint32_t surplus_entry;
 114         uint32_t surplus_exit;
 115         uint16_t options;
 116         uint16_t pad[3];
 117         uint64_t message_ctx;
 118         uint64_t message_iova;
 119 };
 120
 121 struct dpbp_rsp_get_api_version {
 122         uint16_t major;
 123         uint16_t minor;
 124 };
 125
 126 struct dpbp_rsp_get_num_free_bufs {
 127         uint32_t num_free_bufs;
 128 };
 129
 130 #pragma pack(pop)
 131 #endif /* _FSL_DPBP_CMD_H */