fhi_lib/lib/api/xran_sync_api.h

   1 /******************************************************************************\r
   2 *\r
   3 *   Copyright (c) 2019 Intel.\r
   4 *\r
   5 *   Licensed under the Apache License, Version 2.0 (the "License");\r
   6 *   you may not use this file except in compliance with the License.\r
   7 *   You may obtain a copy of the License at\r
   8 *\r
   9 *       http://www.apache.org/licenses/LICENSE-2.0\r
  10 *\r
  11 *   Unless required by applicable law or agreed to in writing, software\r
  12 *   distributed under the License is distributed on an "AS IS" BASIS,\r
  13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14 *   See the License for the specific language governing permissions and\r
  15 *   limitations under the License.\r
  16 *\r
  17 *******************************************************************************/\r
  18 \r
  19 /**\r
  20  * @brief This file provides interface to synchronization related APIs (PTP/1588)\r
  21  *        for XRAN.\r
  22  *\r
  23  * @file xran_sync_api.h\r
  24  * @ingroup group_lte_source_xran\r
  25  * @author Intel Corporation\r
  26  *\r
  27  **/\r
  28 \r
  29 #ifndef _XRAN_SYNC_API_H_\r
  30 #define _XRAN_SYNC_API_H_\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif\r
  35 \r
  36 /**\r
  37  * @brief Function checks if machine is synchronized using PTP for Linux\r
  38  *        software.\r
  39  *\r
  40  * @return int Returns 0 if synchronized, otherwise positive.\r
  41  */\r
  42 int xran_is_synchronized(void);\r
  43 \r
  44 #ifdef __cplusplus\r
  45 }\r
  46 #endif\r
  47 \r
  48 #endif /* _XRAN_SYNC_API_H_ */\r