examples/ip_pipeline/thread.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 THREAD_H_
  35 #define THREAD_H_
  36
  37 #include "app.h"
  38 #include "pipeline_be.h"
  39
  40 enum thread_msg_req_type {
  41         THREAD_MSG_REQ_PIPELINE_ENABLE = 0,
  42         THREAD_MSG_REQ_PIPELINE_DISABLE,
  43         THREAD_MSG_REQ_HEADROOM_READ,
  44         THREAD_MSG_REQS
  45 };
  46
  47 struct thread_msg_req {
  48         enum thread_msg_req_type type;
  49 };
  50
  51 struct thread_msg_rsp {
  52         int status;
  53 };
  54
  55 /*
  56  * PIPELINE ENABLE
  57  */
  58 struct thread_pipeline_enable_msg_req {
  59         enum thread_msg_req_type type;
  60
  61         uint32_t pipeline_id;
  62         void *be;
  63         pipeline_be_op_run f_run;
  64         pipeline_be_op_timer f_timer;
  65         uint64_t timer_period;
  66 };
  67
  68 struct thread_pipeline_enable_msg_rsp {
  69         int status;
  70 };
  71
  72 /*
  73  * PIPELINE DISABLE
  74  */
  75 struct thread_pipeline_disable_msg_req {
  76         enum thread_msg_req_type type;
  77
  78         uint32_t pipeline_id;
  79 };
  80
  81 struct thread_pipeline_disable_msg_rsp {
  82         int status;
  83 };
  84
  85 /*
  86  * THREAD HEADROOM
  87  */
  88 struct thread_headroom_read_msg_req {
  89         enum thread_msg_req_type type;
  90 };
  91
  92 struct thread_headroom_read_msg_rsp {
  93         int status;
  94
  95         double headroom_ratio;
  96 };
  97
  98 #endif /* THREAD_H_ */