app_sensor.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 APP_SENSOR_H__
#define APP_SENSOR_H__

#include <stdint.h>

#include "list.h"

#include "sensor_messages.h"
#include "sensor_setup_server.h"
#include "app_timer.h"

typedef uint8_t pir_data_size_t;

/* Forward declaration */
typedef struct __app_sensor_server_t app_sensor_server_t;

/* internal data for mid-app */
typedef uint8_t descriptor_status_t;

#define APP_SENSOR_SERVER_DEF(_name, _force_segmented, _mic_size, _get_cb, \
 _settings_get_cb, _setting_set_cb, \
 _setting_get_cb, _column_get_cb, _series_get_cb, \
 _property_array, \
 _cadence_timer_ids, \
 _min_interval_timer_ids, \
 _descriptor_struct_array, _num_descs, \
 _p_message_buffer, _message_buffer_bytes); \
 static uint8_t m_descriptor_buf[_num_descs * SENSOR_DESCRIPTOR_MSG_SIZE]; \
 static app_sensor_server_t _name = \
 { \
 .server.settings.force_segmented = _force_segmented, \
 .server.settings.transmic_size = _mic_size, \
 .sensor_get_cb = _get_cb, \
 .sensor_settings_get_cb = _settings_get_cb, \
 .sensor_setting_set_cb = _setting_set_cb, \
 .sensor_setting_get_cb = _setting_get_cb, \
 .sensor_column_get_cb = _column_get_cb, \
 .sensor_series_get_cb = _series_get_cb, \
 .p_sensor_property_array = _property_array, \
 .p_cadence_timer_ids = _cadence_timer_ids, \
 .p_min_interval_timer_ids = _min_interval_timer_ids, \
 .p_sensor_descriptor = _descriptor_struct_array, \
 .p_descriptor_message = m_descriptor_buf, \
 .sensor_num_desc = _num_descs, \
 .p_message_buffer = _p_message_buffer, \
 .message_buffer_bytes = _message_buffer_bytes \
 };


typedef struct
{
 list_node_t * p_cadence_list;
 uint16_t marshalled_list_bytes;
} app_sensor_state_t;

typedef void (*app_sensor_get_cb_t)(const app_sensor_server_t * p_server,
 uint16_t property_id,
 uint8_t * p_out,
 uint16_t * p_out_bytes);


typedef void (*app_sensor_settings_get_cb_t)(const app_sensor_server_t * p_server,
 uint16_t property_id,
 sensor_settings_status_msg_pkt_t * p_out,
 uint16_t * p_out_bytes);

typedef void (*app_sensor_setting_set_cb_t)(const app_sensor_server_t * p_server,
 uint16_t property_id,
 uint16_t setting_property_id,
 const sensor_setting_set_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_setting_status_msg_pkt_t * p_out,
 uint16_t * p_out_bytes);

typedef void (*app_sensor_setting_get_cb_t)(const app_sensor_server_t * p_server,
 uint16_t property_id,
 uint16_t setting_property_id,
 sensor_setting_status_msg_pkt_t * p_out,
 uint16_t * p_out_bytes);

typedef void (*app_sensor_column_get_cb_t)(const app_sensor_server_t * p_server,
 const sensor_column_get_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_column_status_msg_pkt_t * p_out,
 uint16_t * p_out_bytes);

typedef void (*app_sensor_series_get_cb_t)(const app_sensor_server_t * p_server,
 const sensor_series_get_msg_pkt_t * p_in,
 uint16_t in_bytes,
 sensor_series_status_msg_pkt_t * p_out,
 uint16_t * p_out_bytes);


struct __app_sensor_server_t
{
 sensor_setup_server_t server;

 app_sensor_get_cb_t sensor_get_cb;
 app_sensor_settings_get_cb_t sensor_settings_get_cb;
 app_sensor_setting_set_cb_t sensor_setting_set_cb;

 app_sensor_setting_get_cb_t sensor_setting_get_cb;
 app_sensor_column_get_cb_t sensor_column_get_cb;
 app_sensor_series_get_cb_t sensor_series_get_cb;

 uint16_t * p_sensor_property_array;

 app_timer_id_t const * p_cadence_timer_ids;

 app_timer_id_t const * p_min_interval_timer_ids;

 /* the number of descriptors
 */
 uint16_t sensor_num_desc;
 /* the actual descriptor(s)
 */
 const sensor_descriptor_t * p_sensor_descriptor;
 uint8_t * p_message_buffer;
 uint16_t message_buffer_bytes;

 app_sensor_state_t state;
 descriptor_status_t * p_descriptor_message;
};

uint32_t app_sensor_init(app_sensor_server_t * p_server, uint16_t element_index);

#endif /* APP_SENSOR_H__ */