device.hh revision 11262:3aeb879a66e6
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com * Copyright (c) 2012 ARM Limited 311986Sandreas.sandberg@arm.com * All rights reserved 411986Sandreas.sandberg@arm.com * 511986Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 611986Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 711986Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 811986Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 911986Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1011986Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1111986Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1211986Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1311986Sandreas.sandberg@arm.com * 1411986Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 1511986Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 1611986Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 1711986Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 1811986Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 1911986Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 2011986Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 2111986Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 2211986Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 2311986Sandreas.sandberg@arm.com * this software without specific prior written permission. 2411986Sandreas.sandberg@arm.com * 2511986Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2611986Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2711986Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2811986Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2911986Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3011986Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3111986Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3211986Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3311986Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3411986Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3511986Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.* 3611986Sandreas.sandberg@arm.com * 3711986Sandreas.sandberg@arm.com * Authors: Peter Enns 3811986Sandreas.sandberg@arm.com */ 3911986Sandreas.sandberg@arm.com 4011986Sandreas.sandberg@arm.com 4111986Sandreas.sandberg@arm.com/** @file 4211986Sandreas.sandberg@arm.com * All i2c devices should derive from this class. 4311986Sandreas.sandberg@arm.com */ 4411986Sandreas.sandberg@arm.com 4511986Sandreas.sandberg@arm.com#ifndef __DEV_I2C_DEVICE_HH__ 4611986Sandreas.sandberg@arm.com#define __DEV_I2C_DEVICE_HH__ 4711986Sandreas.sandberg@arm.com 4812391Sjason@lowepower.com#include "base/types.hh" 4914299Sbbruce@ucdavis.edu#include "params/I2CDevice.hh" 5011986Sandreas.sandberg@arm.com#include "sim/sim_object.hh" 5111986Sandreas.sandberg@arm.com 5214299Sbbruce@ucdavis.educlass I2CDevice : public SimObject 5311986Sandreas.sandberg@arm.com{ 5411986Sandreas.sandberg@arm.com 5511986Sandreas.sandberg@arm.com protected: 5611986Sandreas.sandberg@arm.com 5711986Sandreas.sandberg@arm.com uint8_t _addr; 5811986Sandreas.sandberg@arm.com 5911986Sandreas.sandberg@arm.com public: 6011986Sandreas.sandberg@arm.com 6111986Sandreas.sandberg@arm.com I2CDevice(const I2CDeviceParams* p) 6211986Sandreas.sandberg@arm.com : SimObject(p), _addr(p->i2c_addr) 6311986Sandreas.sandberg@arm.com { } 6411986Sandreas.sandberg@arm.com 6511986Sandreas.sandberg@arm.com virtual ~I2CDevice() { } 6611986Sandreas.sandberg@arm.com 6711986Sandreas.sandberg@arm.com /** 6811986Sandreas.sandberg@arm.com * Return the next message that the device expects to send. This 6911986Sandreas.sandberg@arm.com * will likely have side effects (e.g., incrementing a register 7011986Sandreas.sandberg@arm.com * pointer). 7111986Sandreas.sandberg@arm.com * 7211986Sandreas.sandberg@arm.com * @return 8-bit message the device has been set up to send 7311986Sandreas.sandberg@arm.com */ 7411986Sandreas.sandberg@arm.com virtual uint8_t read() = 0; 7511986Sandreas.sandberg@arm.com 7611986Sandreas.sandberg@arm.com /** 7712037Sandreas.sandberg@arm.com * Perform any actions triggered by an i2c write (save msg in a 7811986Sandreas.sandberg@arm.com * register, perform an interrupt, update a register pointer or 7911986Sandreas.sandberg@arm.com * command register, etc...) 8011986Sandreas.sandberg@arm.com * 8111986Sandreas.sandberg@arm.com * @param msg 8-bit message from master 8211986Sandreas.sandberg@arm.com */ 8314299Sbbruce@ucdavis.edu virtual void write(uint8_t msg) = 0; 8414299Sbbruce@ucdavis.edu 8514299Sbbruce@ucdavis.edu /** 8614299Sbbruce@ucdavis.edu * Perform any initialization necessary for the device when it 8711986Sandreas.sandberg@arm.com * received a start signal from the bus master (devices frequently 8812391Sjason@lowepower.com * expect the first write to be a register address) 8912037Sandreas.sandberg@arm.com */ 9011986Sandreas.sandberg@arm.com virtual void i2cStart() = 0; 9111986Sandreas.sandberg@arm.com 9211986Sandreas.sandberg@arm.com uint8_t i2cAddr() const { return _addr; } 9311986Sandreas.sandberg@arm.com 9411986Sandreas.sandberg@arm.com}; 9514299Sbbruce@ucdavis.edu 9611986Sandreas.sandberg@arm.com#endif // __DEV_I2C_DEVICE__ 9712391Sjason@lowepower.com