sn_grs.h

00001 /*
00002  * Copyright (c) 2011-2015 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef GRS_H_
00017 #define GRS_H_
00018 
00019 
00020 #ifdef __cplusplus
00021 extern "C" {
00022 #endif
00023 
00024 
00025 #define SN_GRS_RESOURCE_ALREADY_EXISTS  -2
00026 #define SN_GRS_INVALID_PATH             -3
00027 #define SN_GRS_LIST_ADDING_FAILURE      -4
00028 #define SN_GRS_RESOURCE_UPDATED     -5
00029 
00030 #define ACCESS_DENIED           -6
00031 
00032 #define SN_GRS_DELETE_METHOD    0
00033 #define SN_GRS_SEARCH_METHOD    1
00034 
00035 #define SN_GRS_DEFAULT_ACCESS   0x0F
00036 
00037 #define SN_NDSL_RESOURCE_NOT_REGISTERED 0
00038 #define SN_NDSL_RESOURCE_REGISTERING    1
00039 #define SN_NDSL_RESOURCE_REGISTERED     2
00040 #define SN_NDSL_RESOURCE_DELETE         3
00041 
00042 /***** Structs *****/
00043 
00044 typedef struct sn_grs_version_ {
00045     uint8_t major_version;
00046     uint8_t minor_version;
00047     uint8_t build;
00048 } sn_grs_version_s;
00049 
00050 typedef NS_LIST_HEAD(sn_nsdl_dynamic_resource_parameters_s, link) resource_list_t;
00051 
00052 struct grs_s {
00053     struct coap_s *coap;
00054 
00055     void *(*sn_grs_alloc)(uint16_t);
00056     void (*sn_grs_free)(void *);
00057     uint8_t (*sn_grs_tx_callback)(struct nsdl_s *, sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *);
00058     int8_t (*sn_grs_rx_callback)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *);
00059 
00060     uint16_t resource_root_count;
00061     resource_list_t resource_root_list;
00062 };
00063 
00064 
00065 struct nsdl_s {
00066     uint32_t update_register_token;
00067     uint32_t register_token;
00068     uint32_t unregister_token;
00069     uint32_t bootstrap_token;
00070     uint32_t token_seed;
00071     unsigned int sn_nsdl_endpoint_registered:1;
00072     unsigned int is_bs_server:1;
00073 
00074     struct grs_s *grs;
00075     sn_nsdl_ep_parameters_s *ep_information_ptr;     // Endpoint parameters, Name, Domain etc..
00076     sn_nsdl_addr_s server_address;                   // server address information
00077     /* Application definable context. This is useful for example when interfacing with c++ objects where a pointer to object is set as the
00078      * context, and in the callback functions the context pointer can be used to call methods for the correct instance of the c++ object. */
00079     void *context;
00080 
00081     void *(*sn_nsdl_alloc)(uint16_t);
00082     void (*sn_nsdl_free)(void *);
00083     uint8_t (*sn_nsdl_tx_callback)(struct nsdl_s *, sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *);
00084     uint8_t (*sn_nsdl_rx_callback)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *);
00085     uint8_t (*sn_nsdl_auto_obs_token_callback)(struct nsdl_s *, const char*, uint8_t*);
00086 };
00087 
00088 /***** Function prototypes *****/
00089 /**
00090  *  \fn extern grs_s *sn_grs_init   (uint8_t (*sn_grs_tx_callback_ptr)(sn_nsdl_capab_e , uint8_t *, uint16_t,
00091  *                                  sn_nsdl_addr_s *), uint8_t (*sn_grs_rx_callback_ptr)(sn_coap_hdr_s *, sn_nsdl_addr_s *),
00092  *                                  sn_grs_mem_s *sn_memory)
00093  *
00094  *  \brief GRS library initialize function.
00095  *
00096  *  This function initializes GRS and CoAP.
00097  *
00098  *  \param  sn_grs_tx_callback      A function pointer to a transmit callback function. Should return 1 when succeed, 0 when failed
00099  *  \param  *sn_grs_rx_callback_ptr A function pointer to a receiving callback function. If received packet is not for GRS, it will be passed to
00100  *                                  upper level (NSDL) to be proceed.
00101  *  \param  sn_memory               A pointer to a structure containing the platform specific functions for memory allocation and free.
00102  *
00103  *  \return success pointer to handle, failure = NULL
00104  *
00105 */
00106 extern struct grs_s *sn_grs_init(uint8_t (*sn_grs_tx_callback_ptr)(struct nsdl_s *, sn_nsdl_capab_e , uint8_t *, uint16_t,
00107                                  sn_nsdl_addr_s *),
00108                                  int8_t (*sn_grs_rx_callback_ptr)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *),
00109                                  void *(*sn_grs_alloc)(uint16_t),
00110                                  void (*sn_grs_free)(void *));
00111 
00112 extern sn_nsdl_dynamic_resource_parameters_s    *sn_grs_get_first_resource(struct grs_s *handle);
00113 extern sn_nsdl_dynamic_resource_parameters_s    *sn_grs_get_next_resource(struct grs_s *handle,
00114                                                                           const sn_nsdl_dynamic_resource_parameters_s *sn_grs_current_resource);
00115 extern int8_t                                   sn_grs_process_coap(struct nsdl_s *handle,
00116                                                                     sn_coap_hdr_s *coap_packet_ptr,
00117                                                                     sn_nsdl_addr_s *src);
00118 extern sn_nsdl_dynamic_resource_parameters_s    *sn_grs_search_resource(struct grs_s *handle,
00119                                                                         const char *path,
00120                                                                         uint8_t search_method);
00121 extern int8_t                                   sn_grs_destroy(struct grs_s *handle);
00122 extern int8_t                                   sn_grs_send_coap_message(struct nsdl_s *handle,
00123                                                                          sn_nsdl_addr_s *address_ptr,
00124                                                                          sn_coap_hdr_s *coap_hdr_ptr);
00125 extern int8_t                                   sn_grs_put_resource(struct grs_s *handle, sn_nsdl_dynamic_resource_parameters_s *res);
00126 extern int8_t                                   sn_grs_pop_resource(struct grs_s *handle, sn_nsdl_dynamic_resource_parameters_s *res);
00127 extern int8_t                                   sn_grs_delete_resource(struct grs_s *handle, const char *path);
00128 extern void                                     sn_grs_mark_resources_as_registered(struct nsdl_s *handle);
00129 
00130 #ifdef __cplusplus
00131 }
00132 #endif
00133 
00134 
00135 
00136 
00137 #endif /* GRS_H_ */