examples/ip_pipeline/pipeline/pipeline_flow_classification_be.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_PIPELINE_FLOW_CLASSIFICATION_BE_H__
  35 #define __INCLUDE_PIPELINE_FLOW_CLASSIFICATION_BE_H__
  36
  37 #include "pipeline_common_be.h"
  38
  39 enum pipeline_fc_msg_req_type {
  40         PIPELINE_FC_MSG_REQ_FLOW_ADD = 0,
  41         PIPELINE_FC_MSG_REQ_FLOW_ADD_BULK,
  42         PIPELINE_FC_MSG_REQ_FLOW_DEL,
  43         PIPELINE_FC_MSG_REQ_FLOW_ADD_DEFAULT,
  44         PIPELINE_FC_MSG_REQ_FLOW_DEL_DEFAULT,
  45         PIPELINE_FC_MSG_REQS,
  46 };
  47
  48 #ifndef PIPELINE_FC_FLOW_KEY_MAX_SIZE
  49 #define PIPELINE_FC_FLOW_KEY_MAX_SIZE            64
  50 #endif
  51
  52 /*
  53  * MSG ADD
  54  */
  55 struct pipeline_fc_add_msg_req {
  56         enum pipeline_msg_req_type type;
  57         enum pipeline_fc_msg_req_type subtype;
  58
  59         uint8_t key[PIPELINE_FC_FLOW_KEY_MAX_SIZE];
  60
  61         uint32_t port_id;
  62         uint32_t flow_id;
  63 };
  64
  65 struct pipeline_fc_add_msg_rsp {
  66         int status;
  67         int key_found;
  68         void *entry_ptr;
  69 };
  70
  71 /*
  72  * MSG ADD BULK
  73  */
  74 struct pipeline_fc_add_bulk_flow_req {
  75         uint8_t key[PIPELINE_FC_FLOW_KEY_MAX_SIZE];
  76         uint32_t port_id;
  77         uint32_t flow_id;
  78 };
  79
  80 struct pipeline_fc_add_bulk_flow_rsp {
  81         int key_found;
  82         void *entry_ptr;
  83 };
  84
  85 struct pipeline_fc_add_bulk_msg_req {
  86         enum pipeline_msg_req_type type;
  87         enum pipeline_fc_msg_req_type subtype;
  88
  89         struct pipeline_fc_add_bulk_flow_req *req;
  90         struct pipeline_fc_add_bulk_flow_rsp *rsp;
  91         uint32_t n_keys;
  92 };
  93
  94 struct pipeline_fc_add_bulk_msg_rsp {
  95         uint32_t n_keys;
  96 };
  97
  98 /*
  99  * MSG DEL
 100  */
 101 struct pipeline_fc_del_msg_req {
 102         enum pipeline_msg_req_type type;
 103         enum pipeline_fc_msg_req_type subtype;
 104
 105         uint8_t key[PIPELINE_FC_FLOW_KEY_MAX_SIZE];
 106 };
 107
 108 struct pipeline_fc_del_msg_rsp {
 109         int status;
 110         int key_found;
 111 };
 112
 113 /*
 114  * MSG ADD DEFAULT
 115  */
 116 struct pipeline_fc_add_default_msg_req {
 117         enum pipeline_msg_req_type type;
 118         enum pipeline_fc_msg_req_type subtype;
 119
 120         uint32_t port_id;
 121 };
 122
 123 struct pipeline_fc_add_default_msg_rsp {
 124         int status;
 125         void *entry_ptr;
 126 };
 127
 128 /*
 129  * MSG DEL DEFAULT
 130  */
 131 struct pipeline_fc_del_default_msg_req {
 132         enum pipeline_msg_req_type type;
 133         enum pipeline_fc_msg_req_type subtype;
 134 };
 135
 136 struct pipeline_fc_del_default_msg_rsp {
 137         int status;
 138 };
 139
 140 extern struct pipeline_be_ops pipeline_flow_classification_be_ops;
 141
 142 #endif