status_definitions.h

/*
 * BSD 3-Clause License
 *
 * Copyright (c) 2019, Analog Devices, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef STATUS_DEFINITIONS_H
#define STATUS_DEFINITIONS_H

#include "sdk_exports.h"

#include <ostream>

namespace aditof {

enum class Status {
    OK,               
    BUSY,             
    UNREACHABLE,      
    INVALID_ARGUMENT, 
    UNAVAILABLE,      
    GENERIC_ERROR     
};

enum class Adsd3500Status {
    OK,                       
    INVALID_MODE,             
    INVALID_JBLF_FILTER_SIZE, 
    UNSUPPORTED_COMMAND,      
    INVALID_MEMORY_REGION,    
    INVALID_FIRMWARE_CRC,     
    INVALID_IMAGER,           
    INVALID_CCB,              
    FLASH_HEADER_PARSE_ERROR, 
    FLASH_FILE_PARSE_ERROR,   
    SPIM_ERROR,               
    INVALID_CHIPID,           
    IMAGER_COMMUNICATION_ERROR, 
    IMAGER_BOOT_FAILURE,        
    FIRMWARE_UPDATE_COMPLETE,   
    NVM_WRITE_COMPLETE,         
    IMAGER_ERROR,               
    UNKNOWN_ERROR_ID            
};

SDK_API std::ostream &operator<<(std::ostream &os, aditof::Status status);

SDK_API std::ostream &operator<<(std::ostream &os,
                                 aditof::Adsd3500Status status);

} // namespace aditof

#endif // STATUS_DEFINITIONS_H