src/vnet/crypto/crypto.api

   1 /*
   2  * Copyright (c) 2020 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "1.0.1";
  17
  18 enum crypto_dispatch_mode:u8
  19 {
  20   CRYPTO_ASYNC_DISPATCH_POLLING = 0,
  21   CRYPTO_ASYNC_DISPATCH_INTERRUPT = 1,
  22 };
  23
  24 enum crypto_op_class_type:u8
  25 {
  26   CRYPTO_API_OP_SIMPLE = 0,
  27   CRYPTO_API_OP_CHAINED,
  28   CRYPTO_API_OP_BOTH,
  29 };
  30
  31  /** \brief crypto: use polling or interrupt dispatch
  32     @param client_index - opaque cookie to identify the sender
  33     @param context - sender context, to match reply w/ request
  34     @param mode - dispatch mode
  35 */
  36
  37 autoreply define crypto_set_async_dispatch
  38 {
  39   option deprecated;
  40   u32 client_index;
  41   u32 context;
  42   vl_api_crypto_dispatch_mode_t mode;
  43 };
  44
  45  /** \brief crypto: set crypto handler
  46     @param client_index - opaque cookie to identify the sender
  47     @param context - sender context, to match reply w/ request
  48     @param alg_name - Name of the algorithm to add
  49     @param engine - Name of the engine to add
  50     @param oct - Operation class type (simple, chained, both)
  51     @param is_async - Asynchronous or not
  52 */
  53
  54 autoreply define crypto_set_handler
  55 {
  56   u32 client_index;
  57   u32 context;
  58   string alg_name[32];
  59   string engine[16];
  60   vl_api_crypto_op_class_type_t oct;
  61   u8 is_async;
  62 };
  63
  64  /*
  65  * Local Variables:
  66  * eval: (c-set-style "gnu")
  67  * End:
  68  */