LSE_timBdy.h File Reference

Defines the body of a Time Specification Contribution. More...

#include <PBI/Endianness.h>

Classes
struct	_LSE_ppsReg_bf
	Maps out the GEM 1PPS register, as bit fields. More...
union	_LSE_ppsReg
	Union of the GEM 1PPS register with an uninterpretted 32-bit integer. More...
struct	_LSE_timFlags_us
	Maps out the Time Specification Flags subrecord as 2 unsigned shorts. More...
union	_LSE_timFlags
	Union of the Time Specification Flags subrecord with an uninterpretted 32-bit integer. More...
struct	_LSE_timBdyFull
	Full Timer Specification Record. More...
struct	_LSE_timBdyAbbreviated
	Abbreviated Timer Specification Record. More...
Typedefs
typedef enum _LSE_PPSREG_S	LSE_PPSREG_S
	Typedef for enum _LSE_PPSREG_S.
typedef enum _LSE_PPSREG_V	LSE_PPSREG_V
	Typedef for enum _LSE_PPSREG_V.
typedef enum _LSE_PPSREG_M	LSE_PPSREG_M
	Typedef for enum _LSE_PPSREG_M.
typedef enum _LSE_PPSREG_N	LSE_PPSREG_N
	Typedef for enum _LSE_PPSREG_N.
typedef struct _LSE_ppsReg_bf	LSE_ppsReg_bf
	Typedef for struct _LSB_ppsReg_bf.
typedef union _LSE_ppsReg	LSE_ppsReg
	Typedef for union _LSE_ppsReg.
typedef struct _LSE_timFlags_us	LSE_timFlags_us
	Typedef for struct _LSD_timFlags_us.
typedef union _LSE_timFlags	LSE_timFlags
	Typedef for union _LSE_timFlags.
typedef struct _LSE_timBdyFull	LSE_timBdyFull
	Typedef for struct _LSE_timBdyFull.
typedef struct _LSE_timBdyAbbreviated	LSE_timBdyAbbreviated
	Typedef for struct _LSE_timBdyAbbreviated.
Enumerations
enum	_LSE_PPSREG_S {   LSE_PPSREG_S_IDX = 7,   LSE_PPSREG_S_VAL = 25 }
	Enumerates the sizes of the bit fields in the GEM 1-PPS register. More...
enum	_LSE_PPSREG_V {   LSE_PPSREG_V_IDX = 25,   LSE_PPSREG_V_VAL = 0 }
	Enumerates the right shifs of the bit fields in the GEM 1-PPS register. More...
enum	_LSE_PPSREG_M {   LSE_PPSREG_M_IDX = ((1 << LSE_PPSREG_S_IDX) - 1) << LSE_PPSREG_V_IDX,   LSE_PPSREG_M_VAL = ((1 << LSE_PPSREG_S_VAL) - 1) << LSE_PPSREG_V_VAL }
	Enumerates the in place masks of the bit fields in the GEM 1-PPS register. More...
enum	_LSE_PPSREG_N {   LSE_PPSREG_N_IDX = ((1 << LSE_PPSREG_S_IDX) - 1),   LSE_PPSREG_N_VAL = ((1 << LSE_PPSREG_S_VAL) - 1) }
	Enumerates the right justified masks of the bit fields in the GEM 1-PPS register. More...

---

Detailed Description

Defines the body of a Time Specification Contribution.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSE_timBdy.h,v 1.5 2011/03/26 17:35:23 russell Exp $

---

Typedef Documentation

LSE_timBdyAbbreviated

Typedef for struct _LSE_timBdyAbbreviated.

This record records a new time record. It is generally only used when updating under the following circumstances

1. The time did not advanced by precisely 1 second from the previous record AND
2. Both of the FSW or Spectrum-Astro flag words were non-zero

LSE_timBdyFull

Typedef for struct _LSE_timBdyFull.

This record records a new time record. It is generally only used when updating under the following circumstances

1. The time did not advance by precisely 1 second from the previous record OR
2. One or both of the FSW or Spectrum-Astro flag words were non-zero

---

Enumeration Type Documentation

enum _LSE_PPSREG_M

Enumerates the in place masks of the bit fields in the GEM 1-PPS register.

Enumerator:

LSE_PPSREG_M_IDX	In place mask of the 1-PPS interrupt index
LSE_PPSREG_M_VAL	In place mask of the value of the system clock register at the 1-PPS interrupt time

enum _LSE_PPSREG_N

Enumerates the right justified masks of the bit fields in the GEM 1-PPS register.

Enumerator:

LSE_PPSREG_N_IDX	In place mask of the 1-PPS interrupt index
LSE_PPSREG_N_VAL	In place mask of the value of the system clock register at the 1-PPS interrupt time

enum _LSE_PPSREG_S

Enumerates the sizes of the bit fields in the GEM 1-PPS register.

Enumerator:

LSE_PPSREG_S_IDX	Size, in bits, of the 1-PPS interrupt index
LSE_PPSREG_S_VAL	Size, in bits, of the value of the system clock register at the 1-PPS interrupt time

enum _LSE_PPSREG_V

Enumerates the right shifs of the bit fields in the GEM 1-PPS register.

Enumerator:

LSE_PPSREG_V_IDX	Right justified shift value of the 1-PPS interrupt index
LSE_PPSREG_V_VAL	Right justified shift value, of the value of the system clock register at the 1-PPS interrupt time