bus.cc revision 10905
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#include "dev/i2cbus.hh" 4111986Sandreas.sandberg@arm.com 4211986Sandreas.sandberg@arm.com#include "debug/Checkpoint.hh" 4311986Sandreas.sandberg@arm.com#include "mem/packet_access.hh" 4411986Sandreas.sandberg@arm.com 4511986Sandreas.sandberg@arm.com// clang complains about std::set being overloaded with Packet::set if 4611986Sandreas.sandberg@arm.com// we open up the entire namespace std 4711986Sandreas.sandberg@arm.comusing std::vector; 4811986Sandreas.sandberg@arm.comusing std::map; 4911986Sandreas.sandberg@arm.com 5011986Sandreas.sandberg@arm.com/** 5111986Sandreas.sandberg@arm.com * 4KB - see e.g. 5211986Sandreas.sandberg@arm.com * http://infocenter.arm.com/help/topic/com.arm.doc.dui0440b/Bbajihec.html 5311986Sandreas.sandberg@arm.com */ 5411986Sandreas.sandberg@arm.comI2CBus::I2CBus(const I2CBusParams *p) 5511986Sandreas.sandberg@arm.com : BasicPioDevice(p, 0xfff), scl(1), sda(1), state(IDLE), currBit(7), 5611986Sandreas.sandberg@arm.com i2cAddr(0x00), message(0x00) 5711986Sandreas.sandberg@arm.com{ 5811986Sandreas.sandberg@arm.com vector<I2CDevice*> devs = p->devices; 5911986Sandreas.sandberg@arm.com 6011986Sandreas.sandberg@arm.com for (auto d : p->devices) { 6111986Sandreas.sandberg@arm.com devices[d->i2cAddr()] = d; 6211986Sandreas.sandberg@arm.com } 6311986Sandreas.sandberg@arm.com} 6411986Sandreas.sandberg@arm.com 6511986Sandreas.sandberg@arm.com/** 6611986Sandreas.sandberg@arm.com * Reads will always be to SB_CONTROLS. The kernel wants to know the state 6711986Sandreas.sandberg@arm.com * of sda and scl. 6811986Sandreas.sandberg@arm.com */ 6911986Sandreas.sandberg@arm.comTick 7011986Sandreas.sandberg@arm.comI2CBus::read(PacketPtr pkt) 7111986Sandreas.sandberg@arm.com{ 7211986Sandreas.sandberg@arm.com assert(pkt->getAddr() == pioAddr + SB_CONTROLS); 7311986Sandreas.sandberg@arm.com 7411986Sandreas.sandberg@arm.com pkt->set<uint8_t>((sda << 1) | scl); 7511986Sandreas.sandberg@arm.com pkt->makeAtomicResponse(); 7611986Sandreas.sandberg@arm.com return pioDelay; 7711986Sandreas.sandberg@arm.com} 7811986Sandreas.sandberg@arm.com 7911986Sandreas.sandberg@arm.com/** 8011986Sandreas.sandberg@arm.com * The default i2c bus driver used by the realview pbx board writes to 8111986Sandreas.sandberg@arm.com * this device one bit at a time. To facilitate making new i2c devices, 8211986Sandreas.sandberg@arm.com * i2cBus::write takes care of the low-level details of the i2c protocol. 8311986Sandreas.sandberg@arm.com * See the I2C Specification [1] for a detailed description of the 8411986Sandreas.sandberg@arm.com * protocol. 8511986Sandreas.sandberg@arm.com * 86 * [1] - http://www.nxp.com/documents/user_manual/UM10204.pdf 87 */ 88Tick 89I2CBus::write(PacketPtr pkt) 90{ 91 assert(pkt->getAddr() == pioAddr + SB_CONTROLS || 92 pkt->getAddr() == pioAddr + SB_CONTROLC); 93 94 updateSignals(pkt); 95 96 // Check if the bus master is starting a new transmission. 97 if (isStart(pkt)) { 98 state = RECEIVING_ADDR; 99 message = 0x00; 100 currBit = 7; 101 /* Most i2c devices expect something special (e.g., command, 102 * register address) in the first byte they receive so they 103 * must be notified somehow that this is a new transmission. 104 */ 105 for (auto& d : devices) { 106 d.second->i2cStart(); 107 } 108 return pioDelay; 109 } 110 111 // Check if the bus master is ending a transmission. 112 if (isEnd(pkt)) { 113 state = IDLE; 114 return pioDelay; 115 } 116 117 // Only change state when the clock is transitioning from low to high. 118 // This may not perfectly mimic physical i2c devices but the important 119 // part is to only do the following once per clock cycle. 120 if (isClockSet(pkt)) { 121 switch (state) { 122 case RECEIVING_ADDR: 123 if (currBit >= 0) { 124 message |= sda << currBit; 125 currBit--; 126 } else { 127 i2cAddr = message >> 1; 128 assert(devices.find(i2cAddr) != devices.end()); 129 if (message & 0x01) { 130 state = SENDING_DATA; 131 message = devices[i2cAddr]->read(); 132 } else { 133 state = RECEIVING_DATA; 134 message = 0x00; 135 } 136 currBit = 7; 137 sda = 0; /* Ack */ 138 } 139 break; 140 case RECEIVING_DATA: 141 if (currBit >= 0) { 142 message |= sda << currBit; 143 currBit--; 144 } else { 145 devices[i2cAddr]->write(message); 146 message = 0x00; 147 currBit = 7; 148 sda = 0; /* Ack */ 149 } 150 break; 151 case SENDING_DATA: 152 if (currBit >= 0) { 153 sda = (message >> currBit) & 0x01; 154 currBit--; 155 } else { 156 if (!sda) /* Check for ack from the bus master. */ 157 message = devices[i2cAddr]->read(); 158 currBit = 7; 159 } 160 break; 161 case IDLE: 162 default: 163 panic("Invalid state on posedge of clock in I2CBus::write.\n"); 164 break; 165 } 166 } 167 168 return pioDelay; 169} 170 171void 172I2CBus::updateSignals(PacketPtr pkt) 173{ 174 uint8_t msg = pkt->get<uint8_t>(); 175 Addr daddr = pkt->getAddr() - pioAddr; 176 177 switch (daddr) { 178 case SB_CONTROLS: 179 scl = (msg & 1) ? 1 : scl; 180 sda = (msg & 2) ? 1 : sda; 181 break; 182 case SB_CONTROLC: 183 scl = (msg & 1) ? 0 : scl; 184 sda = (msg & 2) ? 0 : sda; 185 break; 186 default: 187 break; 188 } 189} 190 191bool 192I2CBus::isClockSet(PacketPtr pkt) const 193{ 194 uint8_t msg = pkt->get<uint8_t>(); 195 Addr daddr = pkt->getAddr() - pioAddr; 196 return daddr == SB_CONTROLS && (msg & 1); 197} 198 199bool 200I2CBus::isStart(PacketPtr pkt) const 201{ 202 uint8_t msg = pkt->get<uint8_t>(); 203 Addr daddr = pkt->getAddr() - pioAddr; 204 return scl && (msg & 2) && daddr == SB_CONTROLC; 205} 206 207bool 208I2CBus::isEnd(PacketPtr pkt) const 209{ 210 uint8_t msg = pkt->get<uint8_t>(); 211 Addr daddr = pkt->getAddr() - pioAddr; 212 return scl && (msg & 2) && daddr == SB_CONTROLS; 213} 214void 215I2CBus::serialize(CheckpointOut &cp) const 216{ 217 DPRINTF(Checkpoint, "Serializing I2C bus.\n"); 218 SERIALIZE_SCALAR(scl); 219 SERIALIZE_SCALAR(sda); 220 SERIALIZE_ENUM(state); 221 SERIALIZE_SCALAR(currBit); 222 SERIALIZE_SCALAR(i2cAddr); 223 SERIALIZE_SCALAR(message); 224} 225 226void 227I2CBus::unserialize(CheckpointIn &cp) 228{ 229 DPRINTF(Checkpoint, "Unserializing I2C bus.\n"); 230 UNSERIALIZE_SCALAR(scl); 231 UNSERIALIZE_SCALAR(sda); 232 UNSERIALIZE_ENUM(state); 233 UNSERIALIZE_SCALAR(currBit); 234 UNSERIALIZE_SCALAR(i2cAddr); 235 UNSERIALIZE_SCALAR(message); 236} 237 238I2CBus* 239I2CBusParams::create() 240{ 241 return new I2CBus(this); 242} 243