health_server.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * 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, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, 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. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS 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.
 */

#ifndef HEALTH_SERVER_H__
#define HEALTH_SERVER_H__

#include <stdbool.h>
#include <stdint.h>

#include "access.h"
#include "bitfield.h"

#include "health_common.h"
#include "nrf_mesh_config_app.h"

#define HEALTH_SERVER_FAULT_ARRAY_SIZE 256

typedef struct __health_server_t health_server_t;

typedef void (*health_server_attention_cb_t)(const health_server_t * p_server, bool attention_state);

typedef void (*health_server_selftest_cb_t)(health_server_t * p_server, uint16_t company_id, uint8_t test_id);

typedef struct
{
 uint8_t test_id; 
 health_server_selftest_cb_t selftest_function; 
} health_server_selftest_t;

typedef uint32_t health_server_fault_array_t[BITFIELD_BLOCK_COUNT(HEALTH_SERVER_FAULT_ARRAY_SIZE)];

struct __health_server_t
{
 access_model_handle_t model_handle; 
 uint8_t fast_period_divisor; 
 const health_server_selftest_t * p_selftests; 
 uint8_t num_selftests; 
 uint8_t previous_test_id; 
 uint16_t company_id; 
 health_server_fault_array_t registered_faults; 
 health_server_fault_array_t current_faults; 
 health_server_attention_cb_t attention_handler; 
 uint8_t attention_timer; 
 struct __health_server_t * p_next; 
};

void health_server_fault_register(health_server_t * p_server, uint8_t fault_code);

void health_server_fault_clear(health_server_t * p_server, uint8_t fault_code);

bool health_server_fault_is_set(health_server_t * p_server, uint8_t fault_code);

uint8_t health_server_fault_count_get(const health_server_t * p_server);

uint8_t health_server_attention_get(const health_server_t * p_server);

void health_server_attention_set(health_server_t * p_server, uint8_t attention);

uint32_t health_server_init(health_server_t * p_server, uint16_t element_index, uint16_t company_id,
 health_server_attention_cb_t attention_cb,
 const health_server_selftest_t * p_selftests, uint8_t num_selftests);

#endif