Commit 0de5ece0 authored by Mikhail Karpenko's avatar Mikhail Karpenko
Browse files

Update doxygen documentation, remove unused functions

parent 1ab4818a
Loading
Loading
Loading
Loading
+0 −2
Original line number Diff line number Diff line
@@ -33,8 +33,6 @@
#include "camogm_kml.h"
#include "camogm_read.h"

/** @brief Time interval (in microseconds) for processing commands */
#define COMMAND_LOOP_DELAY        500000 //0.5sec
/** @brief Default debug level */
#define DEFAULT_DEBUG_LVL         6
/** @brief JPEG trailer syze in bytes */
+2 −0
Original line number Diff line number Diff line
@@ -61,6 +61,8 @@
/** @brief Maximum length of file or raw device path */
#define ELPHEL_PATH_MAX           300
#define MMAP_CHUNK_SIZE           10485760
/** @brief Time interval (in microseconds) for processing commands */
#define COMMAND_LOOP_DELAY        500000

/**
 * @enum state_flags
+174 −197

File changed.

Preview size limit exceeded, changes collapsed.

+38 −1
Original line number Diff line number Diff line
@@ -19,6 +19,26 @@

#include "camogm.h"

/**
 * @struct disk_index
 * @brief Contains a single entry into disk index directory. Each node in
 * the disk index directory corresponds to a file in the raw device buffer and
 * hold its starting offset, sensor port number, time stamp and file size.
 * @var disk_index::next
 * Pointer to the next index node
 * @var disk_index::prev
 * Pointer to the previous disk index node
 * @var disk_index::rawtime
 * Time stamp in UNIX format
 * @var disk_index::usec
 * The microsecond part of the time stamp
 * @var disk_index::port
 * The sensor port number this frame was captured from
 * @var disk_index::f_size
 * File size in bytes
 * @var disk_index::f_offset
 * The offset of the file start in the raw device buffer (in bytes)
 */
struct disk_index {
	struct disk_index *next;
	struct disk_index *prev;
@@ -29,18 +49,35 @@ struct disk_index {
	uint64_t f_offset;
};

/**
 * @struct disk_idir
 * @brief Contains pointers to disk index directory
 * @var disk_idir::head
 * Pointer to the first node of disk index directory
 * @var disk_idir::tail
 * Pointer to the last node of disk index directory
 * @var disk_idir::size
 * The number of nodes in disk index directory
 */
struct disk_idir {
	struct disk_index *head;
	struct disk_index *tail;
	size_t size;
};

/**
 * @struct range
 * @brief Container for offsets in raw device buffer
 * @var range::from
 * Starting offset
 * @var range::to
 * Ending offset
 */
struct range {
	uint64_t from;
	uint64_t to;
};

//void *build_index(void *arg);
void *reader(void *arg);

#endif /* _CAMOGM_READ_H */