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 };
  63
  64 struct pipeline_fc_add_msg_rsp {
  65         int status;
  66         int key_found;
  67         void *entry_ptr;
  68 };
  69
  70 /*
  71  * MSG ADD BULK
  72  */
  73 struct pipeline_fc_add_bulk_flow_req {
  74         uint8_t key[PIPELINE_FC_FLOW_KEY_MAX_SIZE];
  75         uint32_t port_id;
  76 };
  77
  78 struct pipeline_fc_add_bulk_flow_rsp {
  79         int key_found;
  80         void *entry_ptr;
  81 };
  82
  83 struct pipeline_fc_add_bulk_msg_req {
  84         enum pipeline_msg_req_type type;
  85         enum pipeline_fc_msg_req_type subtype;
  86
  87         struct pipeline_fc_add_bulk_flow_req *req;
  88         struct pipeline_fc_add_bulk_flow_rsp *rsp;
  89         uint32_t n_keys;
  90 };
  91
  92 struct pipeline_fc_add_bulk_msg_rsp {
  93         uint32_t n_keys;
  94 };
  95
  96 /*
  97  * MSG DEL
  98  */
  99 struct pipeline_fc_del_msg_req {
 100         enum pipeline_msg_req_type type;
 101         enum pipeline_fc_msg_req_type subtype;
 102
 103         uint8_t key[PIPELINE_FC_FLOW_KEY_MAX_SIZE];
 104 };
 105
 106 struct pipeline_fc_del_msg_rsp {
 107         int status;
 108         int key_found;
 109 };
 110
 111 /*
 112  * MSG ADD DEFAULT
 113  */
 114 struct pipeline_fc_add_default_msg_req {
 115         enum pipeline_msg_req_type type;
 116         enum pipeline_fc_msg_req_type subtype;
 117
 118         uint32_t port_id;
 119 };
 120
 121 struct pipeline_fc_add_default_msg_rsp {
 122         int status;
 123         void *entry_ptr;
 124 };
 125
 126 /*
 127  * MSG DEL DEFAULT
 128  */
 129 struct pipeline_fc_del_default_msg_req {
 130         enum pipeline_msg_req_type type;
 131         enum pipeline_fc_msg_req_type subtype;
 132 };
 133
 134 struct pipeline_fc_del_default_msg_rsp {
 135         int status;
 136 };
 137
 138 extern struct pipeline_be_ops pipeline_flow_classification_be_ops;
 139
 140 #endif