fhi_lib/lib/api/xran_sync_api.h

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