diff options
Diffstat (limited to 'daemons/gptp/linux/src')
| -rw-r--r-- | daemons/gptp/linux/src/linux_hal_common.hpp | 80 | ||||
| -rw-r--r-- | daemons/gptp/linux/src/linux_hal_generic.hpp | 8 | ||||
| -rw-r--r-- | daemons/gptp/linux/src/linux_hal_generic_tsprivate.hpp | 5 | ||||
| -rw-r--r-- | daemons/gptp/linux/src/linux_hal_intelce.hpp | 6 |
4 files changed, 49 insertions, 50 deletions
diff --git a/daemons/gptp/linux/src/linux_hal_common.hpp b/daemons/gptp/linux/src/linux_hal_common.hpp index 229bc14f..4a5ba30e 100644 --- a/daemons/gptp/linux/src/linux_hal_common.hpp +++ b/daemons/gptp/linux/src/linux_hal_common.hpp @@ -65,12 +65,12 @@ extern Timestamp tsToTimestamp(struct timespec *ts); struct TicketingLockPrivate; /** - * Provides the type for the TicketingLock private structure + * @brief Provides the type for the TicketingLock private structure */ typedef struct TicketingLockPrivate * TicketingLockPrivate_t; /** - * TicketingLock: Implements the ticket lock algorithm. + * @brief TicketingLock: Implements the ticket lock algorithm. * A ticket lock consists of two counters, one containing the * number of requests to acquire the lock, and the other the * number of times the lock has been released. A processor acquires the lock @@ -102,13 +102,13 @@ public: bool init(); /** - * Default constructor sets some flags to false that will be initialized on + * @brief Default constructor sets some flags to false that will be initialized on * the init method. Protects against using lock/unlock without calling init. */ TicketingLock(); /** - * Deletes the object and private structures. + * @brief Deletes the object and private structures. */ ~TicketingLock(); private: @@ -120,13 +120,13 @@ private: }; /** - * LinuxTimestamper: Provides a generic hardware + * @brief LinuxTimestamper: Provides a generic hardware * timestamp interface for linux based systems. */ class LinuxTimestamper : public HWTimestamper { public: /** - * Destructor + * @brief Destructor */ virtual ~LinuxTimestamper() = 0; @@ -141,7 +141,7 @@ public: }; /** - * Provides a Linux network generic interface + * @brief Provides a Linux network generic interface */ class LinuxNetworkInterface : public OSNetworkInterface { friend class LinuxNetworkInterfaceFactory; @@ -206,36 +206,36 @@ public: virtual void watchNetLink(IEEE1588Port *pPort); /** - * @brief Gets the payload offset - * @return payload offset + * @brief Gets the payload offset + * @return payload offset */ virtual unsigned getPayloadOffset() { return 0; } /** - * Destroys the network interface + * @brief Destroys the network interface */ ~LinuxNetworkInterface(); protected: /** - * Default constructor + * @brief Default constructor */ LinuxNetworkInterface() {}; }; /** - * Provides a list of LinuxNetworkInterface members + * @brief Provides a list of LinuxNetworkInterface members */ typedef std::list<LinuxNetworkInterface *> LinuxNetworkInterfaceList; struct LinuxLockPrivate; /** - * Provides a type for the LinuxLock class + * @brief Provides a type for the LinuxLock class */ typedef LinuxLockPrivate * LinuxLockPrivate_t; /** - * Extends OSLock generic interface to Linux + * @brief Extends OSLock generic interface to Linux */ class LinuxLock : public OSLock { friend class LinuxLockFactory; @@ -244,7 +244,7 @@ private: LinuxLockPrivate_t _private; protected: /** - * Default constructor. + * @brief Default constructor. */ LinuxLock() { _private = NULL; @@ -259,7 +259,7 @@ protected: bool initialize( OSLockType type ); /** - * Destroys mutexes if lock is still valid + * @brief Destroys mutexes if lock is still valid */ ~LinuxLock(); @@ -283,7 +283,7 @@ protected: }; /** - * Provides a factory pattern for LinuxLock class + * @brief Provides a factory pattern for LinuxLock class */ class LinuxLockFactory:public OSLockFactory { public: @@ -304,12 +304,12 @@ public: struct LinuxConditionPrivate; /** - * Provides a private type for the LinuxCondition class + * @brief Provides a private type for the LinuxCondition class */ typedef struct LinuxConditionPrivate * LinuxConditionPrivate_t; /** - * Extends OSCondition class to Linux + * @brief Extends OSCondition class to Linux */ class LinuxCondition : public OSCondition { friend class LinuxConditionFactory; @@ -357,7 +357,7 @@ public: }; /** - * Implements factory design pattern for LinuxCondition class + * @brief Implements factory design pattern for LinuxCondition class */ class LinuxConditionFactory : public OSConditionFactory { public: @@ -374,7 +374,7 @@ public: struct LinuxTimerQueueActionArg; /** - * Provides a map type for the LinuxTimerQueue class + * @brief Provides a map type for the LinuxTimerQueue class */ typedef std::map < int, struct LinuxTimerQueueActionArg *> LinuxTimerQueueMap_t; @@ -387,12 +387,12 @@ void *LinuxTimerQueueHandler( void *arg ); struct LinuxTimerQueuePrivate; /** - * Provides a private type for the LinuxTimerQueue class + * @brief Provides a private type for the LinuxTimerQueue class */ typedef struct LinuxTimerQueuePrivate * LinuxTimerQueuePrivate_t; /** - * Extends OSTimerQueue to Linux + * @brief Extends OSTimerQueue to Linux */ class LinuxTimerQueue : public OSTimerQueue { friend class LinuxTimerQueueFactory; @@ -406,7 +406,7 @@ private: void LinuxTimerQueueAction( LinuxTimerQueueActionArg *arg ); protected: /** - * Default constructor + * @brief Default constructor */ LinuxTimerQueue() { _private = NULL; @@ -419,7 +419,7 @@ protected: virtual bool init(); public: /** - * Deletes pre-allocated internal variables. + * @brief Deletes pre-allocated internal variables. */ ~LinuxTimerQueue(); @@ -447,7 +447,7 @@ public: }; /** - * Implements factory design pattern for linux + * @brief Implements factory design pattern for linux */ class LinuxTimerQueueFactory : public OSTimerQueueFactory { public: @@ -460,7 +460,7 @@ public: }; /** - * Extends the OSTimer generic class to Linux + * @brief Extends the OSTimer generic class to Linux */ class LinuxTimer : public OSTimer { friend class LinuxTimerFactory; @@ -473,13 +473,13 @@ class LinuxTimer : public OSTimer { virtual unsigned long sleep(unsigned long micros); protected: /** - * Destroys linux timer + * @brief Destroys linux timer */ LinuxTimer() {}; }; /** - * Provides factory design pattern for LinuxTimer + * @brief Provides factory design pattern for LinuxTimer */ class LinuxTimerFactory : public OSTimerFactory { public: @@ -493,7 +493,7 @@ class LinuxTimerFactory : public OSTimerFactory { }; /** - * Privdes the default arguments for the OSThread class + * @brief Provides the default arguments for the OSThread class */ struct OSThreadArg { OSThreadFunction func; /*!< Callback function */ @@ -510,12 +510,12 @@ void *OSThreadCallback(void *input); struct LinuxThreadPrivate; /** - * Provides a private type for the LinuxThread class + * @brief Provides a private type for the LinuxThread class */ typedef LinuxThreadPrivate * LinuxThreadPrivate_t; /** - * Extends OSThread class to Linux + * @brief Extends OSThread class to Linux */ class LinuxThread : public OSThread { friend class LinuxThreadFactory; @@ -543,7 +543,7 @@ class LinuxThread : public OSThread { }; /** - * Provides factory design pattern for LinuxThread class + * @brief Provides factory design pattern for LinuxThread class */ class LinuxThreadFactory:public OSThreadFactory { public: @@ -557,7 +557,7 @@ class LinuxThreadFactory:public OSThreadFactory { }; /** - * Extends OSNetworkInterfaceFactory for LinuxNetworkInterface + * @brief Extends OSNetworkInterfaceFactory for LinuxNetworkInterface */ class LinuxNetworkInterfaceFactory : public OSNetworkInterfaceFactory { public: @@ -574,7 +574,7 @@ public: }; /** - * Extends IPC ARG generic interface to linux + * @brief Extends IPC ARG generic interface to linux */ class LinuxIPCArg : public OS_IPC_ARG { private: @@ -591,7 +591,7 @@ public: this->group_name[len] = '\0'; } /** - * Destroys IPCArg internal variables + * @brief Destroys IPCArg internal variables */ virtual ~LinuxIPCArg() { delete group_name; @@ -602,7 +602,7 @@ public: #define DEFAULT_GROUPNAME "ptp" /*!< Default groupname for the shared memory interface*/ /** - * Linux shared memory interface + * @brief Linux shared memory interface */ class LinuxSharedMemoryIPC:public OS_IPC { private: @@ -611,7 +611,7 @@ private: int err; public: /** - * Initializes the internal flags + * @brief Initializes the internal flags */ LinuxSharedMemoryIPC() { shm_fd = 0; @@ -619,7 +619,7 @@ public: master_offset_buffer = NULL; }; /** - * Destroys and unlinks shared memory + * @brief Destroys and unlinks shared memory */ ~LinuxSharedMemoryIPC(); @@ -640,7 +640,7 @@ public: * @param sync_count Count of syncs * @param pdelay_count Count of pdelays * @param port_state Port's state - * @param asCapable asCapable flag + * @param asCapable asCapable flag * @return TRUE */ virtual bool update diff --git a/daemons/gptp/linux/src/linux_hal_generic.hpp b/daemons/gptp/linux/src/linux_hal_generic.hpp index fc3be46d..5b33dad5 100644 --- a/daemons/gptp/linux/src/linux_hal_generic.hpp +++ b/daemons/gptp/linux/src/linux_hal_generic.hpp @@ -40,7 +40,7 @@ struct LinuxTimestamperGenericPrivate; /** - * Povides LinuxTimestamperGeneric a private type + * @brief Provides LinuxTimestamperGeneric a private type */ typedef struct LinuxTimestamperGenericPrivate * LinuxTimestamperGenericPrivate_t; @@ -50,7 +50,7 @@ typedef struct LinuxTimestamperIGBPrivate * LinuxTimestamperIGBPrivate_t; #endif /** - * Linux timestamper generic interface + * @brief Linux timestamper generic interface */ class LinuxTimestamperGeneric : public LinuxTimestamper { private: @@ -71,7 +71,7 @@ private: public: /** - * Default constructor. Initializes internal variables + * @brief Default constructor. Initializes internal variables */ LinuxTimestamperGeneric(); @@ -185,7 +185,7 @@ public: #endif /** - * deletes LinuxTimestamperGeneric object + * @brief deletes LinuxTimestamperGeneric object */ virtual ~LinuxTimestamperGeneric(); }; diff --git a/daemons/gptp/linux/src/linux_hal_generic_tsprivate.hpp b/daemons/gptp/linux/src/linux_hal_generic_tsprivate.hpp index 0bc101f2..a43e1c37 100644 --- a/daemons/gptp/linux/src/linux_hal_generic_tsprivate.hpp +++ b/daemons/gptp/linux/src/linux_hal_generic_tsprivate.hpp @@ -42,7 +42,7 @@ extern "C" { #include <igb.h> } /** - * Private IGB structure. + * @brief Private IGB structure. */ struct LinuxTimestamperIGBPrivate { device_t igb_dev; @@ -51,8 +51,7 @@ struct LinuxTimestamperIGBPrivate { #endif /** - * Provides private members for the - * LinuxTimestamperGeneric class + * @brief Provides private members for the LinuxTimestamperGeneric class */ struct LinuxTimestamperGenericPrivate { pthread_mutex_t cross_stamp_lock; /*!< Cross timestamp lock*/ diff --git a/daemons/gptp/linux/src/linux_hal_intelce.hpp b/daemons/gptp/linux/src/linux_hal_intelce.hpp index c09d01ef..c6e1e31b 100644 --- a/daemons/gptp/linux/src/linux_hal_intelce.hpp +++ b/daemons/gptp/linux/src/linux_hal_intelce.hpp @@ -40,7 +40,7 @@ /**@file*/ /** - * Extends the LinuxTimestamper to IntelCE cards + * @brief Extends the LinuxTimestamper to IntelCE cards */ class LinuxTimestamperIntelCE : public LinuxTimestamper { private: @@ -99,13 +99,13 @@ public: bool post_init( int ifindex, int sd, TicketingLock *lock ); /** - * Destroys timestamper + * @brief Destroys timestamper */ virtual ~LinuxTimestamperIntelCE() { } /** - * Default constructor. Initialize some internal variables + * @brief Default constructor. Initialize some internal variables */ LinuxTimestamperIntelCE() { last_tx_time = 0; |