sdLog.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013-2016 Gautier Hattenberger, Alexandre Bustico
 *
 * This file is part of paparazzi.
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * paparazzi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * @file modules/loggers/sdlog_chibios/sdLog.h
 * @brief sdlog API using ChibiOS and Fatfs
 *
 */

#pragma once
#include "std.h"
#include "mcuconf.h"

//#include "ff.h"
#include <stdarg.h>

#define NUMBERLEN 4
#define NUMBERMAX 9999
#define NUMBERFMF "%s\\%s%.04d.LOG"

#ifdef __cplusplus
extern "C" {
#endif

/*
  This module is highly coupled with fatfs, and mcuconf.h
  several MACRO should be defined before use

    FATFS (ffconf.h) :
    ° _FS_LOCK : number of simultaneously open file
    ° _FS_REENTRANT : If you need to open / close file during log, this should be set to 1 at
                       the expense of more used cam and cpu.
                      If you open all files prior to log data on them, it should be left to 0

 MCUCONF.H (or any other header included before sdLog.h
 ° SDLOG_ALL_BUFFERS_SIZE : (in bytes) cache buffer size shared between all opened log file
 ° SDLOG_MAX_MESSAGE_LEN  : (in bytes) maximum length of a message
 ° SDLOG_QUEUE_BUCKETS    : number of entries in queue

 use of the api :
 sdLogInit (initialize peripheral,  verify sdCard availibility)
 sdLogOpenLog : open file
 sdLogWriteXXX
 sdLogFlushLog : flush buffer (optional)
 sdLogCloseLog
 sdLogFinish

 and asynchronous emergency close (power outage detection by example) :
 sdLogCloseAllLogs
 sdLogFinish

 */


#if SDLOG_ALL_BUFFERS_SIZE == 0 || SDLOG_MAX_MESSAGE_LEN == 0 || \
    SDLOG_QUEUE_BUCKETS  == 0
#undef SDLOG_NEED_QUEUE
#else
#define SDLOG_NEED_QUEUE
#endif


#ifdef SDLOG_NEED_QUEUE
typedef struct LogMessage LogMessage;
#endif

typedef enum {
  SDLOG_OK,
  SDLOG_NOCARD,
  SDLOG_FATFS_ERROR,
  SDLOG_FATFS_NOENT,
  SDLOG_FSFULL,
  SDLOG_FDFULL,
  SDLOG_QUEUEFULL,
  SDLOG_NOTHREAD,
  SDLOG_INTERNAL_ERROR,
  SDLOG_LOGNUM_ERROR,
  SDLOG_WAS_LAUNCHED
} SdioError;

typedef struct _SdLogBuffer SdLogBuffer;
typedef int8_t FileDes;



SdioError sdLogInit(uint32_t *freeSpaceInKo);

SdioError getFileName(const char *prefix, const char *directoryName,
                      char *nextFileName, const size_t nameLength, const int indexOffset);




SdioError removeEmptyLogs(const char *directoryName, const char *prefix,
                          const size_t sizeConsideredEmpty);
SdioError sdLogFinish(void);


#ifdef SDLOG_NEED_QUEUE

SdioError sdLogOpenLog(FileDes *fileObject, const char *directoryName, const char *fileName,
                       bool appendTagAtClose);


SdioError sdLogFlushLog(const FileDes fileObject);


SdioError sdLogCloseLog(const FileDes fileObject);

SdioError sdLogCloseAllLogs(bool flush);


SdioError sdLogWriteLog(const FileDes fileObject, const char *fmt, ...);


SdioError sdLogWriteRaw(const FileDes fileObject, const uint8_t *buffer, const size_t len);

SdioError sdLogAllocSDB(SdLogBuffer **sdb, const size_t len);

char *sdLogGetBufferFromSDB(SdLogBuffer *sdb);


bool sdLogSeekBufferFromSDB(SdLogBuffer *sdb, uint32_t offset);


size_t sdLogGetBufferLenFromSDB(SdLogBuffer *sdb);

SdioError sdLogWriteSDB(const FileDes fd, SdLogBuffer *sdb);


SdioError sdLogWriteByte(const FileDes fileObject, const uint8_t value);
#endif


#ifdef __cplusplus
}
#endif