43d49a21d0
In anticipation of support for external time stamping in PHC devices, this patch adds wrapper functions around the pin functionality. Signed-off-by: Richard Cochran <richardcochran@gmail.com>
81 lines
2.3 KiB
C
81 lines
2.3 KiB
C
/**
|
|
* @file phc.h
|
|
* @note Copyright (C) 2011 Richard Cochran <richardcochran@gmail.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
#ifndef HAVE_PHC_H
|
|
#define HAVE_PHC_H
|
|
|
|
#include "missing.h"
|
|
|
|
/**
|
|
* Opens a PTP hardware clock device.
|
|
*
|
|
* @param phc The device to open.
|
|
*
|
|
* @return A valid clock ID on success, CLOCK_INVALID otherwise.
|
|
*/
|
|
clockid_t phc_open(const char *phc);
|
|
|
|
/**
|
|
* Closes a PTP hardware clock device.
|
|
*
|
|
* @param clkid A clock ID obtained using phc_open().
|
|
*/
|
|
void phc_close(clockid_t clkid);
|
|
|
|
/**
|
|
* Query the maximum frequency adjustment of a PTP hardware clock device.
|
|
*
|
|
* @param clkid A clock ID obtained using phc_open().
|
|
*
|
|
* @return The clock's maximum frequency adjustment in parts per billion.
|
|
*/
|
|
int phc_max_adj(clockid_t clkid);
|
|
|
|
/**
|
|
* Queries the number of programmable pins of a PTP hardware clock device.
|
|
*
|
|
* @param clkid A clock ID obtained using phc_open().
|
|
*
|
|
* @return The number of pins supported by the clock.
|
|
*/
|
|
int phc_number_pins(clockid_t clkid);
|
|
|
|
/**
|
|
* Configures a pin of a PTP hardware clock device.
|
|
*
|
|
* @param clkid A clock ID obtained using phc_open().
|
|
*
|
|
* @param desc Pointer to a pin descriptor with the 'index', 'func',
|
|
* and 'chan' fields set.
|
|
*
|
|
* @return Zero on success, non-zero otherwise.
|
|
*/
|
|
int phc_pin_setfunc(clockid_t clkid, struct ptp_pin_desc *desc);
|
|
|
|
/**
|
|
* Checks whether the given PTP hardware clock device supports PPS output.
|
|
*
|
|
* @param clkid A clock ID obtained using phc_open().
|
|
*
|
|
* @return Zero if PPS output is not supported by the clock, non-zero
|
|
* otherwise.
|
|
*/
|
|
int phc_has_pps(clockid_t clkid);
|
|
|
|
#endif
|