bosch_drivers_hardware_interface.hpp

Go to the documentation of this file.

/*********************************************************************
 *
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2012, Robert Bosch LLC.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * 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.
 *   * Neither the name of the Robert Bosch 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 OWNER 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.
 *
 *********************************************************************/

//\Author Joshua Vasquez and Philip Roan, Robert Bosch LLC

#ifndef BOSCH_DRIVERS_HARDWARE_INTERFACE_H_
#define BOSCH_DRIVERS_HARDWARE_INTERFACE_H_

#include <string>

#include "bosch_drivers_common.hpp"

namespace bosch_drivers_common
{
  class bosch_hardware_interface    
  {
    
  public:                                               
    
    // constructor
    bosch_hardware_interface() {};
    // destructor
    virtual ~bosch_hardware_interface() {};
    
    virtual bool initialize () = 0;
    
    virtual ssize_t read( int device_address, 
                          interface_protocol protocol, 
                          int frequency, 
                          int* flags, // relevant for SPI communiction
                          uint8_t reg_address, 
                          uint8_t* data, 
                          size_t num_bytes ) = 0;               
        
    virtual ssize_t write( int device_address, 
                           interface_protocol protocol, 
                           int frequency,
                           int* flags, 
                           uint8_t reg_address, 
                           uint8_t* data, 
                           size_t num_bytes ) = 0;      

    virtual bool supportedProtocol( interface_protocol protocol ) = 0;
  
    virtual std::string getID() = 0;                  
  };
}

#endif //BOSCH_DRIVERS_HARDWARE_INTERFACE_H_