DS9400.hpp

00001 /*******************************************************************************
00002 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterfaceDevices_DS9400_hpp
00034 #define MaximInterfaceDevices_DS9400_hpp
00035 
00036 #include <MaximInterfaceCore/I2CMaster.hpp>
00037 #include <MaximInterfaceCore/Uart.hpp>
00038 #include "Config.hpp"
00039 
00040 namespace MaximInterfaceDevices {
00041 
00042 class DS9400 : public Core::I2CMaster {
00043 public:
00044   explicit DS9400(Core::Uart & uart) : uart(&uart) {}
00045 
00046   void setUart(Core::Uart & uart) { this->uart = &uart; }
00047 
00048   MaximInterfaceDevices_EXPORT Core::Result<void> waitAwake();
00049 
00050   MaximInterfaceDevices_EXPORT Core::Result<void> start();
00051 
00052   MaximInterfaceDevices_EXPORT virtual Core::Result<void>
00053   start(uint_least8_t address);
00054 
00055   MaximInterfaceDevices_EXPORT virtual Core::Result<void> stop();
00056 
00057   MaximInterfaceDevices_EXPORT virtual Core::Result<void>
00058   writeByte(uint_least8_t data);
00059 
00060   MaximInterfaceDevices_EXPORT virtual Core::Result<uint_least8_t>
00061   readByte(DoAck doAck);
00062 
00063 protected:
00064   MaximInterfaceDevices_EXPORT Core::Result<void>
00065   configure(uint_least8_t config);
00066 
00067 private:
00068   Core::Uart * uart;
00069 };
00070 
00071 } // namespace MaximInterfaceDevices
00072 
00073 #endif