The beginning of doxygenation, for the Linux port:
As a first step, added an @file description for each file.
This commit is contained in:
@@ -38,6 +38,8 @@
|
|||||||
#include "arcnet.h"
|
#include "arcnet.h"
|
||||||
#include "net.h"
|
#include "net.h"
|
||||||
|
|
||||||
|
/** @file linux/arcnet.c Provides Linux-specific functions for Arcnet. */
|
||||||
|
|
||||||
/* my local device data - MAC address */
|
/* my local device data - MAC address */
|
||||||
uint8_t ARCNET_MAC_Address = 0;
|
uint8_t ARCNET_MAC_Address = 0;
|
||||||
/* ARCNET file handle */
|
/* ARCNET file handle */
|
||||||
|
|||||||
@@ -38,6 +38,8 @@
|
|||||||
#include "bip.h"
|
#include "bip.h"
|
||||||
#include "net.h"
|
#include "net.h"
|
||||||
|
|
||||||
|
/** @file linux/bip-init.c Initializes BACnet/IP interface (Linux). */
|
||||||
|
|
||||||
bool BIP_Debug = false;
|
bool BIP_Debug = false;
|
||||||
|
|
||||||
/* gets an IP address by name, where name can be a
|
/* gets an IP address by name, where name can be a
|
||||||
|
|||||||
@@ -38,6 +38,8 @@
|
|||||||
/* OS Specific include */
|
/* OS Specific include */
|
||||||
#include "net.h"
|
#include "net.h"
|
||||||
|
|
||||||
|
/** @file linux/dlmstp.c Provides Linux-specific DataLink functions for MS/TP. */
|
||||||
|
|
||||||
/* Number of MS/TP Packets Rx/Tx */
|
/* Number of MS/TP Packets Rx/Tx */
|
||||||
uint16_t MSTP_Packets = 0;
|
uint16_t MSTP_Packets = 0;
|
||||||
|
|
||||||
|
|||||||
@@ -40,6 +40,8 @@
|
|||||||
#include "ethernet.h"
|
#include "ethernet.h"
|
||||||
#include "bacint.h"
|
#include "bacint.h"
|
||||||
|
|
||||||
|
/** @file linux/ethernet.c Provides Linux-specific functions for BACnet/Ethernet. */
|
||||||
|
|
||||||
/* commonly used comparison address for ethernet */
|
/* commonly used comparison address for ethernet */
|
||||||
uint8_t Ethernet_Broadcast[MAX_MAC_LEN] =
|
uint8_t Ethernet_Broadcast[MAX_MAC_LEN] =
|
||||||
{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
|
{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
|
||||||
|
|||||||
@@ -45,7 +45,8 @@
|
|||||||
#include "txbuf.h"
|
#include "txbuf.h"
|
||||||
#include "dlenv.h"
|
#include "dlenv.h"
|
||||||
|
|
||||||
/* This is an example application using the BACnet Stack on Linux */
|
/** @file linux/main.c Example application using the BACnet Stack on Linux. */
|
||||||
|
|
||||||
bool Who_Is_Request = true;
|
bool Who_Is_Request = true;
|
||||||
|
|
||||||
/* buffers used for receiving */
|
/* buffers used for receiving */
|
||||||
|
|||||||
@@ -48,6 +48,8 @@
|
|||||||
#include "mstptext.h"
|
#include "mstptext.h"
|
||||||
#include "bacint.h"
|
#include "bacint.h"
|
||||||
|
|
||||||
|
/** @file linux/mstpsnap.c Example application testing BACnet MS/TP on Linux. */
|
||||||
|
|
||||||
#ifndef max
|
#ifndef max
|
||||||
#define max(a,b) (((a) (b)) ? (a) : (b))
|
#define max(a,b) (((a) (b)) ? (a) : (b))
|
||||||
#define min(a,b) (((a) < (b)) ? (a) : (b))
|
#define min(a,b) (((a) < (b)) ? (a) : (b))
|
||||||
|
|||||||
@@ -95,3 +95,5 @@
|
|||||||
#include <netdb.h>
|
#include <netdb.h>
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/** @file linux/net.h Includes Linux network headers. */
|
||||||
|
|||||||
@@ -33,6 +33,8 @@
|
|||||||
-------------------------------------------
|
-------------------------------------------
|
||||||
####COPYRIGHTEND####*/
|
####COPYRIGHTEND####*/
|
||||||
|
|
||||||
|
/** @file linux/rs485.c Provides Linux-specific functions for RS-485 serial. */
|
||||||
|
|
||||||
/* The module handles sending data out the RS-485 port */
|
/* The module handles sending data out the RS-485 port */
|
||||||
/* and handles receiving data from the RS-485 port. */
|
/* and handles receiving data from the RS-485 port. */
|
||||||
/* Customize this file for your specific hardware */
|
/* Customize this file for your specific hardware */
|
||||||
|
|||||||
@@ -54,6 +54,8 @@
|
|||||||
#include "mstp.h"
|
#include "mstp.h"
|
||||||
#include "mstptext.h"
|
#include "mstptext.h"
|
||||||
|
|
||||||
|
/** @file linux/rx_fsm.c Example app testing MS/TP Rx State Machine on Linux. */
|
||||||
|
|
||||||
#ifndef max
|
#ifndef max
|
||||||
#define max(a,b) (((a) (b)) ? (a) : (b))
|
#define max(a,b) (((a) (b)) ? (a) : (b))
|
||||||
#define min(a,b) (((a) < (b)) ? (a) : (b))
|
#define min(a,b) (((a) < (b)) ? (a) : (b))
|
||||||
|
|||||||
@@ -28,6 +28,8 @@
|
|||||||
#include <time.h>
|
#include <time.h>
|
||||||
#include "timer.h"
|
#include "timer.h"
|
||||||
|
|
||||||
|
/** @file linux/timer.c Provides Linux-specific time and timer functions. */
|
||||||
|
|
||||||
/* counter for the various timers */
|
/* counter for the various timers */
|
||||||
static volatile uint32_t Millisecond_Counter[MAX_MILLISECOND_TIMERS];
|
static volatile uint32_t Millisecond_Counter[MAX_MILLISECOND_TIMERS];
|
||||||
|
|
||||||
|
|||||||
@@ -26,6 +26,7 @@
|
|||||||
|
|
||||||
#include <stdbool.h>
|
#include <stdbool.h>
|
||||||
#include <stdint.h>
|
#include <stdint.h>
|
||||||
|
#include <sys/time.h> // for timeval
|
||||||
|
|
||||||
/* Timer Module */
|
/* Timer Module */
|
||||||
#ifndef MAX_MILLISECOND_TIMERS
|
#ifndef MAX_MILLISECOND_TIMERS
|
||||||
|
|||||||
Reference in New Issue
Block a user