bosch_drivers_hardware_interface.hpp
Go to the documentation of this file.
00001 /*********************************************************************
00002  *
00003  * Software License Agreement (BSD License)
00004  *
00005  *  Copyright (c) 2012, Robert Bosch LLC.
00006  *  All rights reserved.
00007  *
00008  *  Redistribution and use in source and binary forms, with or without
00009  *  modification, are permitted provided that the following conditions
00010  *  are met:
00011  *
00012  *   * Redistributions of source code must retain the above copyright
00013  *     notice, this list of conditions and the following disclaimer.
00014  *   * Redistributions in binary form must reproduce the above
00015  *     copyright notice, this list of conditions and the following
00016  *     disclaimer in the documentation and/or other materials provided
00017  *     with the distribution.
00018  *   * Neither the name of the Robert Bosch nor the names of its
00019  *     contributors may be used to endorse or promote products derived
00020  *     from this software without specific prior written permission.
00021  *
00022  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00025  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00026  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00027  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00028  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00029  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00032  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033  *  POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  *********************************************************************/
00036 
00037 //\Author Joshua Vasquez and Philip Roan, Robert Bosch LLC
00038 
00039 #ifndef BOSCH_DRIVERS_HARDWARE_INTERFACE_H_
00040 #define BOSCH_DRIVERS_HARDWARE_INTERFACE_H_
00041 
00042 #include <string>
00043 
00044 #include "bosch_drivers_common.hpp"
00045 
00046 namespace bosch_drivers_common
00047 {
00060   class bosch_hardware_interface    
00061   {
00062     
00063   public:                                               
00064     
00065     // constructor
00066     bosch_hardware_interface() {};
00067     // destructor
00068     virtual ~bosch_hardware_interface() {};
00069     
00078     virtual bool initialize () = 0;
00079     
00104     virtual ssize_t read( int device_address, 
00105                           interface_protocol protocol, 
00106                           int frequency, 
00107                           int* flags, // relevant for SPI communiction
00108                           uint8_t reg_address, 
00109                           uint8_t* data, 
00110                           size_t num_bytes ) = 0;               
00111         
00139     virtual ssize_t write( int device_address, 
00140                            interface_protocol protocol, 
00141                            int frequency,
00142                            int* flags, 
00143                            uint8_t reg_address, 
00144                            uint8_t* data, 
00145                            size_t num_bytes ) = 0;      
00146 
00150     virtual bool supportedProtocol( interface_protocol protocol ) = 0;
00151   
00158     virtual std::string getID() = 0;                  
00159   };
00160 }
00161 
00162 #endif //BOSCH_DRIVERS_HARDWARE_INTERFACE_H_
00163 
00164 
00165 
00166 
00167 
00168 
00169 
00170 
00171 
00172 
00173 
00174 
00175 
00176 
00177 
00178 
00179 
00180 
00181 
00182 
00183 
00184 
00185 
00186 
00187 
00188 
00189 
00190 
00191 
00192 
00193 
00194 
00195 


bosch_drivers_common
Author(s): Joshua Vasquez, Philip Roan. Maintained by Philip Roan
autogenerated on Mon Oct 6 2014 10:09:38