secure_device_access.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2017-2019 ARM Ltd.
//  
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//  
//     http://www.apache.org/licenses/LICENSE-2.0
//  
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef __SECURE_DEVICE_ACCESS_H__
#define __SECURE_DEVICE_ACCESS_H__

#include <stdlib.h>
#include <inttypes.h>
#include "sda_status.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef void *sda_operation_ctx_h;

typedef sda_status_e(*user_callback)(sda_operation_ctx_h, void *);

// Type of operation command.
typedef enum {
    SDA_OPERATION_NONE = 0,
    SDA_OPERATION_FUNC_CALL = 1,//Name or reference to operation function.
    SDA_OPERATION_LWM2M = 2     // Not supported.
} sda_command_type_e;

#define SDA_RESPONSE_HEADER_SIZE 24

sda_status_e sda_init(void);

sda_status_e sda_finalize(void);

sda_status_e sda_operation_process(const uint8_t *message,
                                   size_t message_size,
                                   user_callback callback,
                                   void *callback_context,
                                   uint8_t *response_buffer_out,
                                   size_t response_buffer_out_max_size,
                                   size_t *response_message_actual_size_out);

sda_status_e sda_response_data_set(sda_operation_ctx_h handle, uint8_t *buffer,
                                   size_t buffer_size);



sda_status_e sda_scope_get_next(sda_operation_ctx_h handle, const uint8_t **scope_out,
                                size_t *scope_size_out);

sda_status_e sda_command_type_get(sda_operation_ctx_h handle, sda_command_type_e *command_type);

sda_status_e sda_func_call_name_get(sda_operation_ctx_h handle, const uint8_t **func_call_name_out,
                                    size_t *func_call_name_size_out);

sda_status_e sda_func_call_numeric_parameter_get(sda_operation_ctx_h handle, uint32_t index,
        int64_t *num_param_out);

sda_status_e sda_func_call_data_parameter_get(sda_operation_ctx_h handle, uint32_t index,
        const uint8_t **data_param_out,
        size_t *data_param_size_out);


#ifdef __cplusplus
}
#endif

#endif //__SECURE_DEVICE_ACCESS_H__