PTPC driver. More...

Data Structures
struct	ptpc_config_t
	Timer config. More...

Macros
#define	PTPC_EVENT_COMPARE0_MASK PTPC_INT_STS_COMP_INT_STS0_MASK

#define	PTPC_EVENT_CAPTURE0_MASK PTPC_INT_STS_CAPTURE_INT_STS0_MASK

#define	PTPC_EVENT_PPS0_MASK PTPC_INT_STS_PPS_INT_STS0_MASK

#define	PTPC_EVENT_COMPARE1_MASK PTPC_INT_STS_COMP_INT_STS1_MASK

#define	PTPC_EVENT_CAPTURE1_MASK PTPC_INT_STS_CAPTURE_INT_STS1_MASK

#define	PTPC_EVENT_PPS1_MASK PTPC_INT_STS_PPS_INT_STS1_MASK

#define	PTPC_MAX_NS_COUNTER (0x3B9ACA00UL)

Typedefs
typedef enum ptpc_ns_counter_rollover_type	ptpc_ns_counter_rollover_type_t
	Counter types. More...

typedef enum ptpc_capture_trigger_type	ptpc_capture_trigger_type_t
	Capture trigger types. More...

typedef enum ptpc_counting_mode	ptpc_counting_mode
	Capture trigger types. More...

Enumerations
enum	ptpc_ns_counter_rollover_type { ptpc_ns_counter_rollover_binary = 0 , ptpc_ns_counter_rollover_digital = 1 }
	Counter types. More...

enum	ptpc_capture_trigger_type { ptpc_capture_trigger_none = 0 , ptpc_capture_trigger_on_rising_edge = PTPC_PTPC_CTRL0_CAPT_SNAP_POS_EN_MASK , ptpc_capture_trigger_on_failing_edge = PTPC_PTPC_CTRL0_CAPT_SNAP_NEG_EN_MASK , ptpc_capture_trigger_on_both_edges }
	Capture trigger types. More...

enum	ptpc_counting_mode { ptpc_counting_increment = 0 , ptpc_counting_decrement = 1 }
	Capture trigger types. More...

Functions
static void	ptpc_set_ns_counter_rollover (PTPC_Type *ptr, uint8_t index, ptpc_ns_counter_rollover_type_t rollover)
	Configure ns counter rollover mode. More...

static void	ptpc_enable_capture_keep (PTPC_Type *ptr, uint8_t index)
	Enable capture keep. More...

static void	ptpc_disable_capture_keep (PTPC_Type *ptr, uint8_t index)
	Disable capture keep. More...

static void	ptpc_set_ns_counter_update_type (PTPC_Type *ptr, uint8_t index, bool coarse_update)
	Update ns counter update type. More...

static void	ptpc_set_ns_counter_step (PTPC_Type *ptr, uint8_t index, uint32_t ns_step)
	Set ns counter increment step. More...

static void	ptpc_set_second_update (PTPC_Type *ptr, uint8_t index, uint32_t sec)
	Set Second portion update value. More...

hpm_stat_t	ptpc_set_ns_update (PTPC_Type *ptr, uint8_t index, uint32_t ns, ptpc_counting_mode mode)
	Set ns portion update value. More...

static uint32_t	ptpc_get_timestamp_second (PTPC_Type *ptr, uint8_t index)
	Get current timestamp Second portion. More...

static uint32_t	ptpc_get_timestamp_ns (PTPC_Type *ptr, uint8_t index)
	Get timestamp ns portion. More...

static void	ptpc_config_compare (PTPC_Type *ptr, uint8_t index, uint32_t sec, uint32_t ns)
	Config compare. More...

static void	ptpc_update_timestamp_second (PTPC_Type *ptr, uint8_t index, uint32_t sec)
	Update Second portion. More...

static void	ptpc_update_timestamp_ns (PTPC_Type *ptr, uint8_t index, uint32_t ns, ptpc_counting_mode mode)
	Update Ns portion. More...

static void	ptpc_enable_timer (PTPC_Type *ptr, uint8_t index)
	Enable timer. More...

static void	ptpc_disable_timer (PTPC_Type *ptr, uint8_t index)
	Disable timer. More...

static void	ptpc_config_capture (PTPC_Type *ptr, uint8_t index, ptpc_capture_trigger_type_t trigger)
	Config capture trigger event. More...

static uint32_t	ptpc_get_capture_ns (PTPC_Type *ptr, uint8_t index)
	Get snapped ns value. More...

static uint32_t	ptpc_get_capture_second (PTPC_Type *ptr, uint8_t index)
	Get captured second. More...

static void	ptpc_clear_irq_status (PTPC_Type *ptr, uint32_t mask)
	Clear interrupt status. More...

static uint32_t	ptpc_get_irq_status (PTPC_Type *ptr)
	Get interrupt status. More...

static void	ptpc_irq_disable (PTPC_Type *ptr, uint32_t mask)
	Disable interrupt with mask. More...

static void	ptpc_irq_enable (PTPC_Type *ptr, uint32_t mask)
	Enable interrupt with mask. More...

hpm_stat_t	ptpc_init (PTPC_Type ptr, uint8_t index, ptpc_config_t config)
	Initialize PTPC module. More...

hpm_stat_t	ptpc_set_timer_output (PTPC_Type *ptr, uint8_t can_index, bool use_ptpc1)
	Set PTPC output destination. More...

void	ptpc_get_default_config (PTPC_Type ptr, ptpc_config_t config)
	Get default config. More...

void	ptpc_init_timer (PTPC_Type *ptr, uint8_t index)
	Initialize timer to count from 0. More...

hpm_stat_t	ptpc_init_timer_with_initial (PTPC_Type *ptr, uint8_t index, uint32_t sec, uint32_t ns, ptpc_counting_mode mode)
	Initialize timer with initial values. More...

hpm_stat_t	ptpc_update_timer (PTPC_Type *ptr, uint8_t index, uint32_t sec, uint32_t ns, ptpc_counting_mode mode)
	Update timestamp counter. More...

hpm_stat_t	ptpc_set_pps (PTPC_Type *ptr, uint8_t index, uint8_t p)
	Set period of pulse generated per second. More...

Detailed Description

PTPC driver.

Macro Definition Documentation

◆ PTPC_EVENT_CAPTURE0_MASK

#define PTPC_EVENT_CAPTURE0_MASK PTPC_INT_STS_CAPTURE_INT_STS0_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_EVENT_CAPTURE1_MASK

#define PTPC_EVENT_CAPTURE1_MASK PTPC_INT_STS_CAPTURE_INT_STS1_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_EVENT_COMPARE0_MASK

#define PTPC_EVENT_COMPARE0_MASK PTPC_INT_STS_COMP_INT_STS0_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_EVENT_COMPARE1_MASK

#define PTPC_EVENT_COMPARE1_MASK PTPC_INT_STS_COMP_INT_STS1_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_EVENT_PPS0_MASK

#define PTPC_EVENT_PPS0_MASK PTPC_INT_STS_PPS_INT_STS0_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_EVENT_PPS1_MASK

#define PTPC_EVENT_PPS1_MASK PTPC_INT_STS_PPS_INT_STS1_MASK

#include <drivers/inc/hpm_ptpc_drv.h>

◆ PTPC_MAX_NS_COUNTER

#define PTPC_MAX_NS_COUNTER (0x3B9ACA00UL)

#include <drivers/inc/hpm_ptpc_drv.h>

Typedef Documentation

◆ ptpc_capture_trigger_type_t

typedef enum ptpc_capture_trigger_type ptpc_capture_trigger_type_t

#include <drivers/inc/hpm_ptpc_drv.h>

Capture trigger types.

◆ ptpc_counting_mode

typedef enum ptpc_counting_mode ptpc_counting_mode

#include <drivers/inc/hpm_ptpc_drv.h>

Capture trigger types.

◆ ptpc_ns_counter_rollover_type_t

typedef enum ptpc_ns_counter_rollover_type ptpc_ns_counter_rollover_type_t

#include <drivers/inc/hpm_ptpc_drv.h>

Counter types.

Enumeration Type Documentation

◆ ptpc_capture_trigger_type

enum ptpc_capture_trigger_type

#include <drivers/inc/hpm_ptpc_drv.h>

Capture trigger types.

Enumerator
ptpc_capture_trigger_none
ptpc_capture_trigger_on_rising_edge
ptpc_capture_trigger_on_failing_edge
ptpc_capture_trigger_on_both_edges

◆ ptpc_counting_mode

enum ptpc_counting_mode

#include <drivers/inc/hpm_ptpc_drv.h>

Capture trigger types.

Enumerator
ptpc_counting_increment	Increment the counter
ptpc_counting_decrement	Decrement the counter

◆ ptpc_ns_counter_rollover_type

enum ptpc_ns_counter_rollover_type

#include <drivers/inc/hpm_ptpc_drv.h>

Counter types.

Enumerator
ptpc_ns_counter_rollover_binary	binary mode, resolution ~0.466ns, overflow at 0x7FFFFFFF
ptpc_ns_counter_rollover_digital	digital mode, resolution 1ns, overflow at 0x3B9ACA00

Function Documentation

◆ ptpc_clear_irq_status()

static void ptpc_clear_irq_status	(	PTPC_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Clear interrupt status.

Parameters

[in]	ptr	PTPC base address
[in]	mask	Mask of interrupts to be cleared

◆ ptpc_config_capture()

static void ptpc_config_capture	(	PTPC_Type *	ptr,
		uint8_t	index,
		ptpc_capture_trigger_type_t	trigger
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Config capture trigger event.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	trigger	Capture trigger type

◆ ptpc_config_compare()

static void ptpc_config_compare	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	sec,
		uint32_t	ns
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Config compare.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	sec	Target second
[in]	ns	Target ns

◆ ptpc_disable_capture_keep()

static void ptpc_disable_capture_keep	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Disable capture keep.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

◆ ptpc_disable_timer()

static void ptpc_disable_timer	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Disable timer.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

◆ ptpc_enable_capture_keep()

static void ptpc_enable_capture_keep	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Enable capture keep.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

◆ ptpc_enable_timer()

static void ptpc_enable_timer	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Enable timer.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

◆ ptpc_get_capture_ns()

static uint32_t ptpc_get_capture_ns	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Get snapped ns value.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

Returns: ns portion on capture

◆ ptpc_get_capture_second()

static uint32_t ptpc_get_capture_second	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Get captured second.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

Returns: second portion on capture

◆ ptpc_get_default_config()

void ptpc_get_default_config	(	PTPC_Type *	ptr,
		ptpc_config_t *	config
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Get default config.

Parameters

[in]	ptr	PTPC base address
[out]	config	Pointer of config struct

◆ ptpc_get_irq_status()

static uint32_t ptpc_get_irq_status ( PTPC_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Get interrupt status.

Parameters

[in] ptr PTPC base address

Returns: interrupt status mask

◆ ptpc_get_timestamp_ns()

static uint32_t ptpc_get_timestamp_ns	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Get timestamp ns portion.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

Returns: ns value

◆ ptpc_get_timestamp_second()

static uint32_t ptpc_get_timestamp_second	(	PTPC_Type *	ptr,
		uint8_t	index
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Get current timestamp Second portion.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

Returns: Seconds value

◆ ptpc_init()

hpm_stat_t ptpc_init	(	PTPC_Type *	ptr,
		uint8_t	index,
		ptpc_config_t *	config
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Initialize PTPC module.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	config	Pointer to configuration struct

Returns: status_success if everything is okay

◆ ptpc_init_timer()

void ptpc_init_timer	(	PTPC_Type *	ptr,
		uint8_t	index
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Initialize timer to count from 0.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index

◆ ptpc_init_timer_with_initial()

hpm_stat_t ptpc_init_timer_with_initial	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	sec,
		uint32_t	ns,
		ptpc_counting_mode	mode
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Initialize timer with initial values.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	sec	Seconds
[in]	ns	Ns
[in]	mode	Counting mode

Returns: status_success if everything is okay

◆ ptpc_irq_disable()

static void ptpc_irq_disable	(	PTPC_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Disable interrupt with mask.

Parameters

[in]	ptr	PTPC base address
[in]	mask	Mask of interrupts to be disabled

◆ ptpc_irq_enable()

static void ptpc_irq_enable	(	PTPC_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Enable interrupt with mask.

Parameters

[in]	ptr	PTPC base address
[in]	mask	Mask of interrupts to be enabled

◆ ptpc_set_ns_counter_rollover()

static void ptpc_set_ns_counter_rollover	(	PTPC_Type *	ptr,
		uint8_t	index,
		ptpc_ns_counter_rollover_type_t	rollover
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Configure ns counter rollover mode.

Parameters

[in]	ptr	PTPC base address
[in]	index	Index of target counter
[in]	rollover	Rollover type

◆ ptpc_set_ns_counter_step()

static void ptpc_set_ns_counter_step	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	ns_step
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Set ns counter increment step.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	ns_step	Increment step

◆ ptpc_set_ns_counter_update_type()

static void ptpc_set_ns_counter_update_type	(	PTPC_Type *	ptr,
		uint8_t	index,
		bool	coarse_update
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Update ns counter update type.

Parameters

[in]	ptr	PTPC base address
[in]	index	Index of target counter
[in]	coarse_update	Counter will be increment by 1 on

◆ ptpc_set_ns_update()

hpm_stat_t ptpc_set_ns_update	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	ns,
		ptpc_counting_mode	mode
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Set ns portion update value.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	ns	Ns value (31 bits, 0x3B9ACA00 max)
[in]	mode	Counting mode

Returns: status_success if everything is okay

◆ ptpc_set_pps()

hpm_stat_t ptpc_set_pps	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint8_t	p
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Set period of pulse generated per second.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	p	(2^power Hz, from [0 - 15])

Returns: true if requested frequency can be set; false if requested frequency can not be set

◆ ptpc_set_second_update()

static void ptpc_set_second_update	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	sec
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Set Second portion update value.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	sec	Second value

◆ ptpc_set_timer_output()

hpm_stat_t ptpc_set_timer_output	(	PTPC_Type *	ptr,
		uint8_t	can_index,
		bool	use_ptpc1
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Set PTPC output destination.

Parameters

[in]	ptr	PTPC base address
[in]	can_index	Target CAN instance
[in]	use_ptpc1	Use PTPC1 if set to true, otherwise PTPC0

Returns: status_success if everything is okay

◆ ptpc_update_timer()

hpm_stat_t ptpc_update_timer	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	sec,
		uint32_t	ns,
		ptpc_counting_mode	mode
	)

#include <drivers/inc/hpm_ptpc_drv.h>

Update timestamp counter.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	sec	Seconds
[in]	ns	Ns
[in]	mode	Counting mode

Returns: status_success if everything is okay

◆ ptpc_update_timestamp_ns()

static void ptpc_update_timestamp_ns	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	ns,
		ptpc_counting_mode	mode
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Update Ns portion.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	ns	Target ns
[in]	mode	Counting mode

◆ ptpc_update_timestamp_second()

static void ptpc_update_timestamp_second	(	PTPC_Type *	ptr,
		uint8_t	index,
		uint32_t	sec
	)

inlinestatic

#include <drivers/inc/hpm_ptpc_drv.h>

Update Second portion.

Parameters

[in]	ptr	PTPC base address
[in]	index	Target index
[in]	sec	Target second

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ PTPC_EVENT_CAPTURE0_MASK

◆ PTPC_EVENT_CAPTURE1_MASK

◆ PTPC_EVENT_COMPARE0_MASK

◆ PTPC_EVENT_COMPARE1_MASK

◆ PTPC_EVENT_PPS0_MASK

◆ PTPC_EVENT_PPS1_MASK

◆ PTPC_MAX_NS_COUNTER

Typedef Documentation

◆ ptpc_capture_trigger_type_t

◆ ptpc_counting_mode

◆ ptpc_ns_counter_rollover_type_t

Enumeration Type Documentation

◆ ptpc_capture_trigger_type

◆ ptpc_counting_mode

◆ ptpc_ns_counter_rollover_type

Function Documentation

◆ ptpc_clear_irq_status()

◆ ptpc_config_capture()

◆ ptpc_config_compare()

◆ ptpc_disable_capture_keep()

◆ ptpc_disable_timer()

◆ ptpc_enable_capture_keep()

◆ ptpc_enable_timer()

◆ ptpc_get_capture_ns()

◆ ptpc_get_capture_second()

◆ ptpc_get_default_config()

◆ ptpc_get_irq_status()

◆ ptpc_get_timestamp_ns()

◆ ptpc_get_timestamp_second()

◆ ptpc_init()

◆ ptpc_init_timer()

◆ ptpc_init_timer_with_initial()

◆ ptpc_irq_disable()

◆ ptpc_irq_enable()

◆ ptpc_set_ns_counter_rollover()

◆ ptpc_set_ns_counter_step()

◆ ptpc_set_ns_counter_update_type()

◆ ptpc_set_ns_update()

◆ ptpc_set_pps()

◆ ptpc_set_second_update()

◆ ptpc_set_timer_output()

◆ ptpc_update_timer()

◆ ptpc_update_timestamp_ns()

◆ ptpc_update_timestamp_second()