tests/msgq/1.0/ITestMsgQ.hal

   1 /*
   2  * Copyright (C) 2016 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package android.hardware.tests.msgq@1.0;
  18
  19 interface ITestMsgQ {
  20     /*
  21      * This method requests the service to set up Synchronous read/write
  22      * wait-free FMQ with the client as reader.
  23      * @return ret Will be true if the setup is successful, false otherwise.
  24      * @return mqDesc This structure describes the FMQ that was
  25      * set up by the service. Client can use it to set up the FMQ at its end.
  26      */
  27     configureFmqSyncReadWrite()
  28         generates(bool ret, MQDescriptorSync mqDesc);
  29
  30     /*
  31      * This method request the service to write into the FMQ.
  32      * @param count Number to messages to write.
  33      * @return ret Will be true if the write operation was successful,
  34      * false otherwise.
  35      */
  36     requestWrite(int32_t count) generates(bool ret);
  37
  38     /*
  39      * This method request the service to read from the FMQ.
  40      * @param count Number to messages to read.
  41      * @return ret Will be true if the read operation was successful, false
  42      * otherwise.
  43      */
  44     requestRead(int32_t count) generates(bool ret);
  45 };