Fw logs with travis

include/CMakeLists.txt

@@ -16,7 +16,6 @@ target_sources(${LRS_TARGET}
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/h/rs_internal.h"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/h/rs_pipeline.h"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/h/rs_config.h"
-        "${CMAKE_CURRENT_LIST_DIR}/librealsense2/h/rs_terminal_parser.h"
 
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_types.hpp"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_context.hpp"
@@ -30,7 +29,6 @@ target_sources(${LRS_TARGET}
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_options.hpp"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_internal.hpp"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_pipeline.hpp"
-        "${CMAKE_CURRENT_LIST_DIR}/librealsense2/hpp/rs_terminal_parser.hpp"
 
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/rsutil.h"
         "${CMAKE_CURRENT_LIST_DIR}/librealsense2/rs_advanced_mode.h"

include/librealsense2/h/rs_internal.h

@@ -347,6 +347,201 @@ void rs2_software_sensor_add_option(rs2_sensor* sensor, rs2_option option, float
 */
 void rs2_software_sensor_detach(rs2_sensor* sensor, rs2_error** error);
 
+
+/**
+* \brief Creates RealSense firmware log message.
+* \param[in] dev            Device from which the FW log will be taken using the created message
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   pointer to created empty firmware log message
+*/
+rs2_firmware_log_message* rs2_create_fw_log_message(rs2_device* dev, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log.
+* \param[in] dev            Device from which the FW log should be taken
+* \param[in] fw_log_msg     Firmware log message object to be filled
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   true for success, false for failure - failure happens if no firmware log was sent by the hardware monitor
+*/
+int rs2_get_fw_log(rs2_device* dev, rs2_firmware_log_message** fw_log_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense flash log - this is a fw log that has been written in the device during the previous shutdown of the device
+* \param[in] dev            Device from which the FW log should be taken
+* \param[in] fw_log_msg     Firmware log message object to be filled
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   true for success, false for failure - failure happens if no firmware log was sent by the hardware monitor
+*/
+int rs2_get_flash_log(rs2_device* dev, rs2_firmware_log_message** fw_log_msg, rs2_error** error);
+
+/**
+* Delete RealSense firmware log message
+* \param[in]  device    Realsense firmware log message to delete
+*/
+void rs2_delete_fw_log_message(rs2_firmware_log_message* msg);
+
+/**
+* \brief Gets RealSense firmware log message data.
+* \param[in] msg        firmware log message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               pointer to start of the firmware log message data
+*/
+const unsigned char* rs2_fw_log_message_data(rs2_firmware_log_message* msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log message size.
+* \param[in] msg        firmware log message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               size of the firmware log message data
+*/
+int rs2_fw_log_message_size(rs2_firmware_log_message* msg, rs2_error** error);
+
+
+/**
+* \brief Gets RealSense firmware log message timestamp.
+* \param[in] msg        firmware log message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               timestamp of the firmware log message
+*/
+unsigned int rs2_fw_log_message_timestamp(rs2_firmware_log_message* msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log message severity.
+* \param[in] msg        firmware log message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               severity of the firmware log message data
+*/
+rs2_log_severity rs2_fw_log_message_severity(const rs2_firmware_log_message* msg, rs2_error** error);
+
+/**
+* \brief Initializes RealSense firmware logs parser in device.
+* \param[in] dev            Device from which the FW log will be taken
+* \param[in] xml_content    content of the xml file needed for parsing
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   true for success, false for failure - failure happens if opening the xml from the xml_path input fails
+*/
+int rs2_init_fw_log_parser(rs2_device* dev, const char* xml_content, rs2_error** error);
+
+
+/**
+* \brief Creates RealSense firmware log parsed message.
+* \param[in] dev            Device from which the FW log will be taken using the created message
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   pointer to created empty firmware log message
+*/
+rs2_firmware_log_parsed_message* rs2_create_fw_log_parsed_message(rs2_device* dev, rs2_error** error);
+
+/**
+* \brief Deletes RealSense firmware log parsed message.
+* \param[in] msg            message to be deleted
+*/
+void rs2_delete_fw_log_parsed_message(rs2_firmware_log_parsed_message* fw_log_parsed_msg);
+
+
+/**
+* \brief Gets RealSense firmware log parser
+* \param[in] dev                Device from which the FW log will be taken
+* \param[in] fw_log_msg         firmware log message to be parsed
+* \param[in] parsed_msg         firmware log parsed message - place holder for the resulting parsed message
+* \param[out] error             If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                       true for success, false for failure - failure happens if message could not be parsed
+*/
+int rs2_parse_firmware_log(rs2_device* dev, rs2_firmware_log_message* fw_log_msg, rs2_firmware_log_parsed_message* parsed_msg, rs2_error** error);
+
+/**
+* Delete RealSense firmware log parsed message
+* \param[in]  device    Realsense firmware log parsed message to delete
+*/
+void rs2_delete_fw_log_parsed_message(rs2_firmware_log_parsed_message* fw_log_parsed_msg);
+
+/**
+* \brief Gets RealSense firmware log parsed message.
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               message of the firmware log parsed message
+*/
+const char* rs2_get_fw_log_parsed_message(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log parsed message file name.
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error     If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return               file name of the firmware log parsed message
+*/
+const char* rs2_get_fw_log_parsed_file_name(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log parsed message thread name.
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           thread name of the firmware log parsed message
+*/
+const char* rs2_get_fw_log_parsed_thread_name(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log parsed message severity.
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           severity of the firmware log parsed message
+*/
+rs2_log_severity rs2_get_fw_log_parsed_severity(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log parsed message relevant line (in the file that is returned by rs2_get_fw_log_parsed_file_name).
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           line number of the firmware log parsed message
+*/
+unsigned int rs2_get_fw_log_parsed_line(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Gets RealSense firmware log parsed message timestamp
+* \param[in] fw_log_parsed_msg      firmware log parsed message object
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           timestamp of the firmware log parsed message
+*/
+unsigned int rs2_get_fw_log_parsed_timestamp(rs2_firmware_log_parsed_message* fw_log_parsed_msg, rs2_error** error);
+
+/**
+* \brief Creates RealSense terminal parser.
+* \param[in] xml_content    content of the xml file needed for parsing
+* \param[out] error         If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                   pointer to created terminal parser object
+*/
+rs2_terminal_parser* rs2_create_terminal_parser(const char* xml_content, rs2_error** error);
+
+/**
+* \brief Deletes RealSense terminal parser.
+* \param[in] terminal_parser            terminal parser to be deleted
+*/
+void rs2_delete_terminal_parser(rs2_terminal_parser* terminal_parser);
+
+/**
+* \brief Parses terminal command via RealSense terminal parser
+* \param[in] terminal_parser        Terminal parser object
+* \param[in] command                command to be sent to the hw monitor of the device
+* \param[in] size_of_command        size of command to be sent to the hw monitor of the device
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           command to hw monitor, in hex
+*/
+rs2_raw_data_buffer* rs2_terminal_parse_command(rs2_terminal_parser* terminal_parser,
+    const char* command, unsigned int size_of_command, rs2_error** error);
+
+/**
+* \brief Parses terminal response via RealSense terminal parser
+* \param[in] terminal_parser        Terminal parser object
+* \param[in] command                command sent to the hw monitor of the device
+* \param[in] size_of_command        size of the command to sent to the hw monitor of the device
+* \param[in] response               response received by the hw monitor of the device
+* \param[in] size_of_response       size of the response received by the hw monitor of the device
+* \param[out] error                 If non-null, receives any error that occurs during this call, otherwise, errors are ignored.
+* \return                           answer parsed
+*/
+rs2_raw_data_buffer* rs2_terminal_parse_response(rs2_terminal_parser* terminal_parser,
+    const char* command, unsigned int size_of_command,
+    const void* response, unsigned int size_of_response, rs2_error** error);
+
+
 #ifdef __cplusplus
 }
 #endif

include/librealsense2/h/rs_types.h

@@ -180,6 +180,7 @@ typedef enum rs2_extension
     RS2_EXTENSION_FISHEYE_SENSOR,
     RS2_EXTENSION_DEPTH_HUFFMAN_DECODER,
     RS2_EXTENSION_SERIALIZABLE,
+    RS2_EXTENSION_FW_LOGGER,
     RS2_EXTENSION_COUNT
 } rs2_extension;
 const char* rs2_extension_type_to_string(rs2_extension type);
@@ -244,6 +245,9 @@ typedef struct rs2_options_list rs2_options_list;
 typedef struct rs2_devices_changed_callback rs2_devices_changed_callback;
 typedef struct rs2_notification rs2_notification;
 typedef struct rs2_notifications_callback rs2_notifications_callback;
+typedef struct rs2_firmware_log_message rs2_firmware_log_message;
+typedef struct rs2_firmware_log_parsed_message rs2_firmware_log_parsed_message;
+typedef struct rs2_firmware_log_parser rs2_firmware_log_parser;
 typedef struct rs2_terminal_parser rs2_terminal_parser;
 typedef void (*rs2_log_callback_ptr)(rs2_log_severity, rs2_log_message const *, void * arg);
 typedef void (*rs2_notification_callback_ptr)(rs2_notification*, void*);

include/librealsense2/hpp/rs_device.hpp

@@ -226,7 +226,7 @@ namespace rs2
 
             results.insert(results.begin(), start, start + size);
 
-return results;
+            return results;
         }
 
         // Update an updatable device to the provided unsigned firmware. This call is executed on the caller's thread.