event-monitor.h

Go to the documentation of this file.

#ifndef EVE_EVENT_MONITOR_H_INCLUDED
#define EVE_EVENT_MONITOR_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2016, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the EVE platform.
 */

 /**
 * \file
 * \brief Header file for the EVE event monitor primitive.
 *
 * \author DT, Jetro AS
 */ /******************************************************************/

#include <stdbool.h>
#include <core/pm.h>
#include <lib/dlist.h>
#include <lib/env.h>
#include <nrf_soc.h>

/**
 * \addtogroup eventmon Event monitor
 * \{
 * EVE event monitor primitive
 */

/**********************************************************************/
/**
 * Event monitor structure.
 *
 */
struct event_monitor_t
{
  struct dlist_t Link;
  void (*OnSysEvent)(struct event_monitor_t *Self, uint32_t Event);
};

#define EVENT_MONITOR_INIT(name, on_sys_event)                  \
  {                                                             \
    .Link = DLIST_INIT(name.Link),                              \
    .OnSysEvent = on_sys_event,                                 \
  }

#define DECLARE_EVENT_MONITOR(name, on_sys_event)               \
  struct event_monitor_t name                                   \
      __attribute__((cleanup(event_monitor_destructor))) =      \
      EVENT_MONITOR_INIT(name, on_sys_event);                   \
  do {                                                          \
    event_monitor_register(&name);                              \
  } while (0)

void event_monitor_register(struct event_monitor_t *Monitor);

void event_monitor_unregister(struct event_monitor_t *Monitor);

void event_monitor_on_sys_event(uint32_t Event);

/**********************************************************************/
/**
 * Event monitor destructor.
 *
 */
static inline void event_monitor_destructor(struct event_monitor_t *Self)
{
  event_monitor_unregister(Self);
}

/**********************************************************************/
/**
 * Flash operation monitor.
 *
 */
struct flash_op_monitor_t
{
  struct event_monitor_t Super;
  bool Status;
  bool Done;
};

#define FLASH_OP_MONITOR_INIT(name)                             \
  {                                                             \
    .Super = EVENT_MONITOR_INIT(name.Super,                     \
        flash_op_monitor_on_sys_event),                         \
  }

#define DECLARE_FLASH_OP_MONITOR(name)                          \
  struct flash_op_monitor_t name                                \
      __attribute__((cleanup(flash_op_monitor_destructor))) =   \
      FLASH_OP_MONITOR_INIT(name);                              \
  do {                                                          \
    event_monitor_register(&name.Super);                        \
  } while (0)

#define FLASH_OP_WAIT(name)                                     \
  do {                                                          \
    while (!name.Done)                                          \
      pm_relax();                                               \
  } while (0)

static inline void flash_op_monitor_destructor(struct flash_op_monitor_t *Self)
{
  event_monitor_destructor(&Self->Super);
}

static inline void flash_op_monitor_on_sys_event(struct event_monitor_t *Super, uint32_t Event)
{
  struct flash_op_monitor_t *Self =
      container_of(Super, struct flash_op_monitor_t, Super);

  if (Event == NRF_EVT_FLASH_OPERATION_SUCCESS || Event == NRF_EVT_FLASH_OPERATION_ERROR)
  {
    Self->Status = (Event == NRF_EVT_FLASH_OPERATION_SUCCESS);
    Self->Done = true;
    pm_wakeup();
  }
}

/** @} */ /* eventmon */

#endif /* EVE_EVENT_MONITOR_H_INCLUDED */