bt-oal/include/oal-hid-device.h

   1 /*
   2  * Open Adaptation Layer (OAL)
   3  *
   4  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *              http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 #ifndef _OAL_HID_DEVICE_H_
  21 #define _OAL_HID_DEVICE_H_
  22
  23 #include <oal-manager.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /**
  30  * @brief Enable HID Device Feature
  31  *
  32  * @remarks HID Device role will be enabled.
  33  *
  34  * @return OAL_STATUS_SUCCESS on success, otherwise non-zero error value.
  35  * @retval #OAL_STATUS_SUCCESS Successful
  36  *
  37  * @pre OAL API must be initialized with oal_bt_init().
  38  *
  39  * @see hid_device_disable()
  40  */
  41 oal_status_t hid_device_enable(void);
  42
  43
  44 /**
  45  * @brief Disable HID Device Feature
  46  *
  47  * @remarks HID Device role will be disabled.
  48  *
  49  * @return OAL_STATUS_SUCCESS on success, otherwise a non-zero error value.
  50  * @retval #OAL_STATUS_SUCCESS Successful
  51  *
  52  * @pre HID Device should be enabled with hid_device_enable().
  53  *
  54  * @see hid_device_enable()
  55  */
  56 oal_status_t hid_device_disable(void);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif /* __cplusplus */
  61 #endif /* _OAL_HID_DEVICE_H_ */