msg_queue.h

Go to the documentation of this file.

/*
 * Copyright (C) 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/msg_queue.h
 *
 */
#pragma once

#include <ch.h>
#include <hal.h>
#include "modules/tlsf/tlsf_malloc.h"


#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
  MsgQueue_MAILBOX_FULL = -100,
  MsgQueue_MAILBOX_FAIL,
  MsgQueue_MAILBOX_TIMEOUT,
  MsgQueue_MAILBOX_NOT_EMPTY,
  MsgQueue_INVALID_PTR,
  MsgQueue_OK = 0
} MsgQueueStatus;

typedef enum { MsgQueue_REGULAR, MsgQueue_OUT_OF_BAND } MsgQueueUrgency;

typedef struct  MsgQueue MsgQueue;


void msgqueue_init(MsgQueue *que, tlsf_memory_heap_t *heap,
                   msg_t *mb_buf, const cnt_t mb_size);

bool msgqueue_is_full(MsgQueue *que);

bool msgqueue_is_empty(MsgQueue *que);


int32_t msgqueue_send(MsgQueue *que, void *msg, const uint16_t msgLen,
                      const MsgQueueUrgency urgency);


int32_t msgqueue_send_timeout(MsgQueue *que, void *msg, const uint16_t msgLen,
                              const MsgQueueUrgency urgency, const systime_t timout);


int32_t msgqueue_copy_send(MsgQueue *que, const void *msg, const uint16_t msgLen,
                           const MsgQueueUrgency urgency);


int32_t msgqueue_copy_send_timeout(MsgQueue *que, const void *msg, const uint16_t msgLen,
                                   const MsgQueueUrgency urgency, const systime_t timout);



/*
 * goal : (zero copy api)
 * get a message to be processed without copy (blocking)
 *
 * parameters : INOUT queue object
 *        OUT msg pointer
 * return value:
 *
 */

int32_t msgqueue_pop(MsgQueue *que, void **msgPtr);

int32_t msgqueue_pop_timeout(MsgQueue *que, void **msgPtr, const systime_t timout);


/*
  goal : (zero copy api)
  free memory of a precedently given message by PopChunk

  parameters : INOUT queue object
               IN    ChunkBufferRO pointer
 */



const char *msgqueue_strerror(const MsgQueueStatus errno);

/*
#                 _____    _____    _____  __      __   ___    _______   ______
#                |  __ \  |  __ \  |_   _| \ \    / /  / _ \  |__   __| |  ____|
#                | |__) | | |__) |   | |    \ \  / /  | |_| |    | |    | |__
#                |  ___/  |  _  /    | |     \ \/ /   |  _  |    | |    |  __|
#                | |      | | \ \   _| |_     \  /    | | | |    | |    | |____
#                |_|      |_|  \_\ |_____|     \/     |_| |_|    |_|    |______|
*/

struct MsgQueue {
  mailbox_t mb;
  tlsf_memory_heap_t *heap;
} ;


#ifdef __cplusplus
}
#endif