ble_rpc_event_decoder.h

00001 /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved.
00002  *
00003  * The information contained herein is property of Nordic Semiconductor ASA.
00004  * Terms and conditions of usage are described in detail in NORDIC
00005  * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
00006  *
00007  * Licensees are granted free, non-transferable use of the information. NO
00008  * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
00009  * the file.
00010  *
00011  */
00012 
00013 /** @file
00014  *
00015  * @defgroup ble_rpc_evt_decoder Event Decoder
00016  * @{
00017  * @ingroup ble_sdk_lib_serialization
00018  *
00019  * @brief   Decoder for serialized events from nRF51822.
00020  *
00021  * @details This file contains the declaration of the function that initializes the event decoder
00022  *          module and processes received events.
00023  */
00024 
00025 #ifndef BLE_RPC_EVT_DECODER_H__
00026 #define BLE_RPC_EVT_DECODER_H__
00027 
00028 #include <stdint.h>
00029 
00030 #ifndef SVCALL_AS_NORMAL_FUNCTION
00031 #error "The compiler define SVCALL_AS_NORMAL_FUNCTION is not defined."
00032 #endif
00033 
00034 
00035 /**@brief Function for pushing an encoded packet in the event decoder.
00036  *
00037  * @warning This function is not reentrant safe and should always be called from the same interrupt
00038  *          context.
00039  *
00040  * @param[in] p_event_packet       Pointer to the encoded event received.
00041  * @param[in] event_packet_length  Length of received packet.
00042  *
00043  * @retval NRF_SUCCESS       Upon success.
00044  * @retval NRF_ERROR_NO_MEM  Upon receive queue full.
00045  */
00046 uint32_t ble_rpc_event_pkt_received(uint8_t * p_event_packet, uint16_t event_packet_length);
00047 
00048 #endif // BLE_RPC_EVT_DECODER_H__
00049 
00050 /** @} **/