pt_device_object.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2018 ARM Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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 PT_API_VERSION
#define PT_API_VERSION 2
#endif
#if PT_API_VERSION != 2
#error "Including mixed versions of Protocol API"
#endif

#ifndef PT_DEVICE_OBJECT_H_
#define PT_DEVICE_OBJECT_H_

#include <stdbool.h>
#include "pt-client-2/pt_api.h"

#define PT_DEVICE_OBJECT_ID             3
#define PT_MANUFACTURER_RESOURCE_ID     0
#define PT_MODEL_NUMBER_RESOURCE_ID     1
#define PT_SERIAL_NUMBER_RESOURCE_ID    2
#define PT_FIRMWARE_VERSION_RESOURCE_ID 3
#define PT_REBOOT_RESOURCE_ID           4
#define PT_FACTORY_RESET_RESOURCE_ID    5

#define PT_ERROR_CODE_RESOURCE_ID       11
#define PT_RESET_ERROR_CODE_RESOURCE_ID 12

#define PT_DEVICE_TYPE_RESOURCE_ID      17
#define PT_HARDWARE_VERSION_RESOURCE_ID 18
#define PT_SOFTWARE_VERSION_RESOURCE_ID 19

typedef struct ptdo_device_object_data {
    const char *manufacturer; 
    const char *model_number; 
    const char *serial_number; 
    const char *firmware_version; 
    const char *hardware_version; 
    const char *software_version; 
    const char *device_type; 
    pt_resource_callback reboot_callback; 
    pt_resource_callback factory_reset_callback; 
    pt_resource_callback reset_error_code_callback; 
} ptdo_device_object_data_t;

pt_status_t ptdo_initialize_device_object(connection_id_t connection_id,
                                          const char *device_id,
                                          const ptdo_device_object_data_t *device_object_data);

#endif /* PT_DEVICE_OBJECT_H_ */