kdrive_express_services.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2023 WEINZIERL ENGINEERING GmbH
// All rights reserved.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,
// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
//
 
#ifndef __KDRIVE_EXPRESS_SERVICES_H__
#define __KDRIVE_EXPRESS_SERVICES_H__
 
#include "kdrive_express_config.h"
#include "kdrive_express_defs.h"
 
#if KDRIVE_EXPRESS_SERVICES_INCLUDED == 1
 
#define KDRIVE_LOAD_STATE_ADDITIONAL_INFO_LEN (9) 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************
** Init
***************************************************************/
 
kdriveExpress_API int32_t kdrive_sp_create(int32_t ap);
 
kdriveExpress_API bool_t kdrive_sp_release(int32_t sp);
 
/**************************************************************
** Device Services: Response Timeout
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_set_response_timeout(int32_t sp, uint32_t timeout);
 
kdriveExpress_API error_t kdrive_sp_get_response_timeout(int32_t sp, uint32_t* timeout);
 
/**************************************************************
** Device Services: Connection-oriented
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_set_co(int32_t sp, bool_t connection_oriented);
 
kdriveExpress_API bool_t kdrive_sp_is_co(int32_t sp);
 
/**************************************************************
** Device Services: Max APDU length (for long frames support)
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_set_max_apdu_length(int32_t sp, uint32_t max_apdu_length);
 
kdriveExpress_API error_t kdrive_sp_get_max_apdu_length(int32_t sp, uint32_t* max_apdu_length);
 
/**************************************************************
** Device Services: Extended memory services used
** Newer devices supports new extended memory services with long frames
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_set_ext_memory_services_used(int32_t sp, bool_t ext_used);
 
kdriveExpress_API error_t kdrive_sp_are_ext_memory_services_used(int32_t sp, bool_t* ext_used);
 
/**************************************************************
** Device Service: DeviceDescriptorType0Read
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_device_descriptor_type0_read(int32_t sp, uint16_t ind_addr,
        uint16_t* mask_version);
 
/**************************************************************
** Device Service: DeviceDescriptorType2Read
***************************************************************/
 
typedef struct device_descriptor_type2_t
{
        uint16_t manufacturer; 
        uint16_t app_id; 
        uint8_t app_ver; 
        uint8_t mgmt_profile; 
        uint8_t ch_count_a; 
        uint16_t ch_code_a; 
        uint8_t ch_count_b; 
        uint16_t ch_code_b; 
        uint8_t ch_count_c; 
        uint16_t ch_code_c; 
        uint8_t ch_count_d; 
        uint16_t ch_code_d; 
} device_descriptor_type2_t;
 
kdriveExpress_API error_t kdrive_sp_device_descriptor_type2_read(int32_t sp,
        uint16_t ind_addr, device_descriptor_type2_t* desc);
 
/**************************************************************
** Device Service: RestartDeviceType0
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_restart_device_type0(int32_t sp, uint16_t ind_addr);
 
/**************************************************************
** Device Service: RestartDeviceType1
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_restart_device_type1(int32_t sp,
        uint16_t ind_addr,
        uint8_t erase_code,
        uint8_t channel_number,
        uint8_t* error_code,
        uint16_t* process_time);
 
/**************************************************************
** Device Service: PropertyDescriptionRead
***************************************************************/
 
typedef struct property_description_t
{
        uint8_t prop_id; 
        uint8_t prop_index; 
        bool_t write_enable; 
        uint8_t type; 
        uint16_t max_nr_of_elems; 
        uint8_t read_level; 
        uint8_t write_level; 
} property_description_t;
 
kdriveExpress_API error_t kdrive_sp_property_description_read(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        uint8_t prop_index,
        property_description_t* property_description);
 
/**************************************************************
** Device Service: PropertyValueRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_prop_value_read(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: PropertyValueWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_prop_value_write(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        const uint8_t data[],
        uint32_t data_length);
 
kdriveExpress_API error_t kdrive_sp_prop_value_write_without_verify(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: FunctionPropertyCommand
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_function_property_command(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t* return_code,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: FunctionPropertyStateRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_function_property_state_read(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t prop_id,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t* return_code,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: ExtendedPropertyDescriptionRead
***************************************************************/
 
typedef struct ext_property_description_t
{
        uint16_t prop_id; 
        uint16_t prop_index; 
        uint16_t main_dpt; 
        uint16_t sub_dpt; 
        bool_t write_enable; 
        uint8_t pdt; 
        uint16_t max_nr_of_elems; 
        uint8_t read_level; 
        uint8_t write_level; 
} ext_property_description_t;
 
 
kdriveExpress_API error_t kdrive_sp_ext_prop_description_read(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        uint16_t prop_index,
        ext_property_description_t* property_description);
 
/**************************************************************
** Device Service: ExtendedPropertyValueRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_prop_value_read(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: ExtendedPropertyValueWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_prop_value_write(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        const uint8_t data[],
        uint32_t data_length,
        uint8_t* return_code);
 
kdriveExpress_API error_t kdrive_sp_ext_prop_value_write_uncon(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        uint8_t nr_of_elems,
        uint16_t start_index,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** Device Service: ExtendedFunctionPropertyCommand
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_function_property_command(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t* return_code,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: FunctionPropertyStateRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_function_property_state_read(int32_t sp,
        uint16_t ind_addr,
        uint16_t object_type,
        uint16_t object_instance,
        uint16_t prop_id,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t* return_code,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: MemoryRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_memory_read(int32_t sp,
        uint16_t ind_addr,
        uint16_t memory_addr,
        uint8_t number,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: MemoryWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_memory_write(int32_t sp,
        uint16_t ind_addr,
        uint16_t memory_addr,
        const uint8_t data[],
        uint32_t data_length);
 
kdriveExpress_API error_t kdrive_sp_memory_write_without_verify(int32_t sp,
        uint16_t ind_addr,
        uint16_t memory_addr,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: UserMemoryRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_user_memory_read(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        uint8_t number,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: UserMemoryWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_user_memory_write(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        const uint8_t data[],
        uint32_t data_length);
 
kdriveExpress_API error_t kdrive_sp_user_memory_write_without_verify(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        const uint8_t input_data[],
        uint32_t input_data_length,
        uint8_t output_data[],
        uint32_t* output_data_length);
 
/**************************************************************
** Device Service: ExtendedMemoryRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_memory_read(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        uint8_t number,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: ExtendedMemoryWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ext_memory_write(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** Device Service: AuthorizeRequest
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_authorize_request(int32_t sp,
        uint16_t ind_addr,
        uint32_t key,
        uint8_t* level);
 
/**************************************************************
** Device Service: KeyWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_key_write(int32_t sp,
        uint16_t ind_addr,
        uint8_t* level,
        uint32_t key);
 
/**************************************************************
** Device Service: IsIndividualAddressFree
***************************************************************/
 
kdriveExpress_API error_t kdrive_is_ind_addr_free(int32_t sp,
        uint16_t ind_addr,
        bool_t* is_free);
 
/**************************************************************
** Device Service: LoadStateRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_load_state_read(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t* load_state);
 
/**************************************************************
** Device Service: LoadStateWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_load_state_write(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t load_event,
        uint8_t* load_state);
 
kdriveExpress_API error_t kdrive_sp_load_state_write_ex(int32_t sp,
        uint16_t ind_addr,
        uint8_t object_index,
        uint8_t load_event,
        const uint8_t additional_info[KDRIVE_LOAD_STATE_ADDITIONAL_INFO_LEN],
        uint8_t* load_state);
 
/**************************************************************
** Device Service: ReadProgMode
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_read_prog_mode(int32_t sp,
        uint16_t ind_addr,
        bool_t* enabled);
 
kdriveExpress_API error_t kdrive_sp_read_prog_mode_mask_based(int32_t sp,
        uint16_t ind_addr,
        uint16_t mask_version,
        bool_t* enabled);
 
kdriveExpress_API error_t kdrive_sp_read_prog_mode_property_based(int32_t sp,
        uint16_t ind_addr,
        bool_t* enabled);
 
kdriveExpress_API error_t kdrive_sp_read_prog_mode_memory_mapped(int32_t sp,
        uint16_t ind_addr,
        bool_t* enabled);
 
/**************************************************************
** Device Service: SwitchProgMode
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_switch_prog_mode(int32_t sp,
        uint16_t ind_addr,
        bool_t enable);
 
 
kdriveExpress_API error_t kdrive_sp_switch_prog_mode_mask_based(int32_t sp, uint16_t ind_addr, uint16_t mask_version, bool_t enable);
 
kdriveExpress_API error_t kdrive_sp_switch_prog_mode_property_based(int32_t sp,
        uint16_t ind_addr,
        bool_t enable);
 
kdriveExpress_API error_t kdrive_sp_switch_prog_mode_memory_mapped(int32_t sp,
        uint16_t ind_addr,
        bool_t enable);
 
/**************************************************************
** Device Service: MemoryBlockRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_memory_block_read(int32_t sp,
        uint16_t ind_addr,
        uint32_t* memory_addr,
        uint8_t number,
        uint8_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Device Service: MemoryBlockWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_memory_block_write(int32_t sp,
        uint16_t ind_addr,
        uint32_t memory_addr,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** Broadcast Service: IndividualAddressProgModeRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ind_addr_prog_mode_read(int32_t sp,
        uint32_t wait_time,
        uint16_t data[],
        uint32_t* data_length);
 
/**************************************************************
** Broadcast Service: IndividualAddressProgModeWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ind_addr_prog_mode_write(int32_t sp, uint16_t new_ind_addr);
 
/**************************************************************
** Broadcast Service: IndividualAddressSerialNumberRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ind_addr_sn_read(int32_t sp,
        const uint8_t sn[KDRIVE_SN_LEN],
        uint16_t* ind_addr);
 
/**************************************************************
** Broadcast Service: IndividualAddressSerialNumberWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_ind_addr_sn_write(int32_t sp,
        const uint8_t sn[KDRIVE_SN_LEN],
        uint16_t new_ind_addr);
 
/**************************************************************
** Broadcast Service: NetworkParameterWriteBroadcast
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_network_param_write_broadcast(int32_t sp,
        uint16_t object_type,
        uint8_t prop_id,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** System Broadcast Service: NetworkParameterWriteBroadcast
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_network_param_write_systembroadcast(int32_t sp,
        uint16_t object_type,
        uint8_t prop_id,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** System Broadcast Service: SystemNetworkParameterWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_system_network_param_write(int32_t sp,
        uint16_t object_type,
        uint16_t prop_id,
        const uint8_t data[],
        uint32_t data_length);
 
/**************************************************************
** System Broadcast Service: SystemNetworkParameterRead
***************************************************************/
 
typedef struct system_network_param_read_t
{
        uint16_t ind_addr; 
        uint8_t test_info_result[10]; 
        uint32_t length;  
} system_network_param_read_t;
 
kdriveExpress_API error_t kdrive_sp_system_network_param_read(int32_t sp,
        uint16_t object_type,
        uint16_t prop_id,
        const uint8_t data[],
        uint32_t data_length,
        uint32_t wait_time,
        system_network_param_read_t items[],
        uint32_t* items_length);
 
/**************************************************************
** System Broadcast Service: DomainAddressProgModeRead
***************************************************************/
 
typedef struct domain_addr_prog_mode_read_t
{
        uint16_t ind_addr; 
        uint8_t serial_number[KDRIVE_SN_LEN]; 
        uint8_t domain_address[KDRIVE_DA_LEN]; 
} domain_addr_prog_mode_read_t;
 
kdriveExpress_API error_t kdrive_sp_domain_addr_prog_mode_read(int32_t sp,
        uint32_t wait_time,
        domain_addr_prog_mode_read_t items[],
        uint32_t* items_length);
 
/**************************************************************
** System Broadcast Service: DomainAddressProgModeWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_domain_addr_prog_mode_write(int32_t sp, const uint8_t da[KDRIVE_DA_LEN]);
 
/**************************************************************
** System Broadcast Service: DomainAddressSerialNumberRead
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_domain_addr_sn_read(int32_t sp,
        const uint8_t sn[KDRIVE_SN_LEN],
        uint16_t* ind_addr,
        uint8_t da[KDRIVE_DA_LEN]);
 
/**************************************************************
** System Broadcast Service: DomainAddressSerialNumberWrite
***************************************************************/
 
kdriveExpress_API error_t kdrive_sp_domain_addr_sn_write(int32_t sp,
        const uint8_t sn[KDRIVE_SN_LEN],
        const uint8_t da[KDRIVE_DA_LEN]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* KDRIVE_EXPRESS_SERVICES_INCLUDED == 1 */
#endif /* __KDRIVE_EXPRESS_SERVICES_H__ */