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 #ifdef MBED_CLIENT_C_NEW_API
00020 
00021 #include "sn_grs2.h"
00022 
00023 #else
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 
00030 #define SN_GRS_RESOURCE_ALREADY_EXISTS  -2
00031 #define SN_GRS_INVALID_PATH             -3
00032 #define SN_GRS_LIST_ADDING_FAILURE      -4
00033 #define SN_GRS_RESOURCE_UPDATED     -5
00034 
00035 #define ACCESS_DENIED           -6
00036 
00037 #define SN_GRS_DELETE_METHOD    0
00038 #define SN_GRS_SEARCH_METHOD    1
00039 
00040 #define SN_GRS_DEFAULT_ACCESS   0x0F
00041 
00042 #define SN_NDSL_RESOURCE_NOT_REGISTERED 0
00043 #define SN_NDSL_RESOURCE_REGISTERING    1
00044 #define SN_NDSL_RESOURCE_REGISTERED     2
00045 
00046 /***** Structs *****/
00047 
00048 typedef struct sn_grs_version_ {
00049     uint8_t major_version;
00050     uint8_t minor_version;
00051     uint8_t build;
00052 } sn_grs_version_s;
00053 
00054 typedef NS_LIST_HEAD(sn_nsdl_resource_info_s, link) resource_list_t;
00055 
00056 struct grs_s {
00057     struct coap_s *coap;
00058 
00059     void *(*sn_grs_alloc)(uint16_t);
00060     void (*sn_grs_free)(void *);
00061     uint8_t (*sn_grs_tx_callback)(struct nsdl_s *, sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *);
00062     int8_t (*sn_grs_rx_callback)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *);
00063 
00064     uint16_t resource_root_count;
00065     resource_list_t resource_root_list;
00066 };
00067 
00068 
00069 struct nsdl_s {
00070     uint16_t update_register_msg_id;
00071     uint16_t register_msg_len;
00072     uint16_t update_register_msg_len;
00073 
00074     uint16_t register_msg_id;
00075     uint16_t unregister_msg_id;
00076 
00077     uint16_t bootstrap_msg_id;
00078     uint16_t oma_bs_port;                                                       /* Bootstrap port */
00079     uint8_t oma_bs_address_len;                                                 /* Bootstrap address length */
00080     unsigned int sn_nsdl_endpoint_registered:1;
00081     bool handle_bootstrap_msg:1;
00082 
00083     struct grs_s *grs;
00084     uint8_t *oma_bs_address_ptr;                                                /* Bootstrap address pointer. If null, no bootstrap in use */
00085     sn_nsdl_ep_parameters_s *ep_information_ptr;                                // Endpoint parameters, Name, Domain etc..
00086     sn_nsdl_oma_server_info_t *nsp_address_ptr;                                 // NSP server address information
00087     /* Application definable context. This is useful for example when interfacing with c++ objects where a pointer to object is set as the
00088      * context, and in the callback functions the context pointer can be used to call methods for the correct instance of the c++ object. */
00089     void *context;
00090 
00091     void (*sn_nsdl_oma_bs_done_cb)(sn_nsdl_oma_server_info_t *server_info_ptr); /* Callback to inform application when bootstrap is done */
00092     void *(*sn_nsdl_alloc)(uint16_t);
00093     void (*sn_nsdl_free)(void *);
00094     uint8_t (*sn_nsdl_tx_callback)(struct nsdl_s *, sn_nsdl_capab_e , uint8_t *, uint16_t, sn_nsdl_addr_s *);
00095     uint8_t (*sn_nsdl_rx_callback)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *);
00096     void (*sn_nsdl_oma_bs_done_cb_handle)(sn_nsdl_oma_server_info_t *server_info_ptr,
00097                                           struct nsdl_s *handle); /* Callback to inform application when bootstrap is done with nsdl handle */
00098 };
00099 
00100 /***** Function prototypes *****/
00101 /**
00102  *  \fn extern grs_s *sn_grs_init   (uint8_t (*sn_grs_tx_callback_ptr)(sn_nsdl_capab_e , uint8_t *, uint16_t,
00103  *                                  sn_nsdl_addr_s *), uint8_t (*sn_grs_rx_callback_ptr)(sn_coap_hdr_s *, sn_nsdl_addr_s *),
00104  *                                  sn_grs_mem_s *sn_memory)
00105  *
00106  *  \brief GRS library initialize function.
00107  *
00108  *  This function initializes GRS and CoAP.
00109  *
00110  *  \param  sn_grs_tx_callback      A function pointer to a transmit callback function. Should return 1 when succeed, 0 when failed
00111  *  \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
00112  *                                  upper level (NSDL) to be proceed.
00113  *  \param  sn_memory               A pointer to a structure containing the platform specific functions for memory allocation and free.
00114  *
00115  *  \return success pointer to handle, failure = NULL
00116  *
00117 */
00118 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,
00119                                  sn_nsdl_addr_s *), int8_t (*sn_grs_rx_callback_ptr)(struct nsdl_s *, sn_coap_hdr_s *, sn_nsdl_addr_s *), void *(*sn_grs_alloc)(uint16_t), void (*sn_grs_free)(void *));
00120 
00121 extern const sn_nsdl_resource_info_s    *sn_grs_get_first_resource(struct grs_s *handle);
00122 extern const sn_nsdl_resource_info_s    *sn_grs_get_next_resource(struct grs_s *handle, const sn_nsdl_resource_info_s *sn_grs_current_resource);
00123 extern int8_t                           sn_grs_process_coap(struct nsdl_s *handle, sn_coap_hdr_s *coap_packet_ptr, sn_nsdl_addr_s *src);
00124 extern sn_nsdl_resource_info_s          *sn_grs_search_resource(struct grs_s *handle, uint16_t pathlen, uint8_t *path, uint8_t search_method);
00125 extern int8_t                           sn_grs_destroy(struct grs_s *handle);
00126 extern sn_grs_resource_list_s           *sn_grs_list_resource(struct grs_s *handle, uint16_t pathlen, uint8_t *path);
00127 extern void                             sn_grs_free_resource_list(struct grs_s *handle, sn_grs_resource_list_s *list);
00128 extern int8_t                           sn_grs_update_resource(struct grs_s *handle, sn_nsdl_resource_info_s *res);
00129 extern int8_t                           sn_grs_send_coap_message(struct nsdl_s *handle, sn_nsdl_addr_s *address_ptr, sn_coap_hdr_s *coap_hdr_ptr);
00130 extern int8_t                           sn_grs_create_resource(struct grs_s *handle, sn_nsdl_resource_info_s *res);
00131 extern int8_t                           sn_grs_put_resource(struct grs_s *handle, sn_nsdl_resource_info_s *res);
00132 extern int8_t                           sn_grs_delete_resource(struct grs_s *handle, uint16_t pathlen, uint8_t *path);
00133 extern void                             sn_grs_mark_resources_as_registered(struct nsdl_s *handle);
00134 
00135 #ifdef __cplusplus
00136 }
00137 #endif
00138 
00139 #endif /* MBED_CLIENT_C_NEW_API */
00140 
00141 
00142 #endif /* GRS_H_ */