* 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.
- *
- * Authors: Gabe Black
*/
+#include "dev/x86/i8042.hh"
+
#include "base/bitunion.hh"
#include "debug/I8042.hh"
-#include "dev/x86/i8042.hh"
#include "mem/packet.hh"
#include "mem/packet_access.hh"
+/**
+ * Note: For details on the implementation see
+ * https://wiki.osdev.org/%228042%22_PS/2_Controller
+ */
+
// The 8042 has a whopping 32 bytes of internal RAM.
const uint8_t RamSize = 32;
const uint8_t NumOutputBits = 14;
-const uint8_t X86ISA::PS2Keyboard::ID[] = {0xab, 0x83};
-const uint8_t X86ISA::PS2Mouse::ID[] = {0x00};
-const uint8_t CommandAck = 0xfa;
-const uint8_t CommandNack = 0xfe;
-const uint8_t BatSuccessful = 0xaa;
X86ISA::I8042::I8042(Params *p)
latency(p->pio_latency),
dataPort(p->data_port), commandPort(p->command_port),
statusReg(0), commandByte(0), dataReg(0), lastCommand(NoCommand),
- mouseIntPin(p->mouse_int_pin), keyboardIntPin(p->keyboard_int_pin)
+ mouse(p->mouse), keyboard(p->keyboard)
{
+ fatal_if(!mouse, "The i8042 model requires a mouse instance");
+ fatal_if(!keyboard, "The i8042 model requires a keyboard instance");
+
statusReg.passedSelfTest = 1;
statusReg.commandLast = 1;
statusReg.keyboardUnlocked = 1;
commandByte.convertScanCodes = 1;
commandByte.passedSelfTest = 1;
commandByte.keyboardFullInt = 1;
+
+ for (int i = 0; i < p->port_keyboard_int_pin_connection_count; i++) {
+ keyboardIntPin.push_back(new IntSourcePin<I8042>(
+ csprintf("%s.keyboard_int_pin[%d]", name(), i), i, this));
+ }
+ for (int i = 0; i < p->port_mouse_int_pin_connection_count; i++) {
+ mouseIntPin.push_back(new IntSourcePin<I8042>(
+ csprintf("%s.mouse_int_pin[%d]", name(), i), i, this));
+ }
}
statusReg.mouseOutputFull = (mouse ? 1 : 0);
if (!mouse && commandByte.keyboardFullInt) {
DPRINTF(I8042, "Sending keyboard interrupt.\n");
- keyboardIntPin->raise();
- //This is a hack
- keyboardIntPin->lower();
+ for (auto *wire: keyboardIntPin) {
+ wire->raise();
+ //This is a hack
+ wire->lower();
+ }
} else if (mouse && commandByte.mouseFullInt) {
DPRINTF(I8042, "Sending mouse interrupt.\n");
- mouseIntPin->raise();
- //This is a hack
- mouseIntPin->lower();
- }
-}
-
-void
-X86ISA::PS2Device::ack()
-{
- bufferData(&CommandAck, sizeof(CommandAck));
-}
-
-void
-X86ISA::PS2Device::nack()
-{
- bufferData(&CommandNack, sizeof(CommandNack));
-}
-
-void
-X86ISA::PS2Device::bufferData(const uint8_t *data, int size)
-{
- assert(data || size == 0);
- while (size) {
- outBuffer.push(*(data++));
- size--;
+ for (auto *wire: mouseIntPin) {
+ wire->raise();
+ //This is a hack
+ wire->lower();
+ }
}
}
uint8_t data = dataReg;
statusReg.outputFull = 0;
statusReg.mouseOutputFull = 0;
- if (keyboard.hasData()) {
- writeData(keyboard.getData(), false);
- } else if (mouse.hasData()) {
- writeData(mouse.getData(), true);
+ if (keyboard->hostDataAvailable()) {
+ writeData(keyboard->hostRead(), false);
+ } else if (mouse->hostDataAvailable()) {
+ writeData(mouse->hostRead(), true);
}
return data;
}
-bool
-X86ISA::PS2Keyboard::processData(uint8_t data)
-{
- if (lastCommand != NoCommand) {
- switch (lastCommand) {
- case LEDWrite:
- DPRINTF(I8042, "Setting LEDs: "
- "caps lock %s, num lock %s, scroll lock %s\n",
- bits(data, 2) ? "on" : "off",
- bits(data, 1) ? "on" : "off",
- bits(data, 0) ? "on" : "off");
- ack();
- lastCommand = NoCommand;
- break;
- case TypematicInfo:
- DPRINTF(I8042, "Setting typematic info to %#02x.\n", data);
- ack();
- lastCommand = NoCommand;
- break;
- }
- return hasData();
- }
- switch (data) {
- case LEDWrite:
- DPRINTF(I8042, "Got LED write command.\n");
- ack();
- lastCommand = LEDWrite;
- break;
- case DiagnosticEcho:
- panic("Keyboard diagnostic echo unimplemented.\n");
- case AlternateScanCodes:
- panic("Accessing alternate scan codes unimplemented.\n");
- case ReadID:
- DPRINTF(I8042, "Got keyboard read ID command.\n");
- ack();
- bufferData((uint8_t *)&ID, sizeof(ID));
- break;
- case TypematicInfo:
- DPRINTF(I8042, "Setting typematic info.\n");
- ack();
- lastCommand = TypematicInfo;
- break;
- case Enable:
- DPRINTF(I8042, "Enabling the keyboard.\n");
- ack();
- break;
- case Disable:
- DPRINTF(I8042, "Disabling the keyboard.\n");
- ack();
- break;
- case DefaultsAndDisable:
- DPRINTF(I8042, "Disabling and resetting the keyboard.\n");
- ack();
- break;
- case AllKeysToTypematic:
- panic("Setting all keys to typemantic unimplemented.\n");
- case AllKeysToMakeRelease:
- panic("Setting all keys to make/release unimplemented.\n");
- case AllKeysToMake:
- panic("Setting all keys to make unimplemented.\n");
- case AllKeysToTypematicMakeRelease:
- panic("Setting all keys to "
- "typematic/make/release unimplemented.\n");
- case KeyToTypematic:
- panic("Setting a key to typematic unimplemented.\n");
- case KeyToMakeRelease:
- panic("Setting a key to make/release unimplemented.\n");
- case KeyToMakeOnly:
- panic("Setting key to make only unimplemented.\n");
- case Resend:
- panic("Keyboard resend unimplemented.\n");
- case Reset:
- panic("Keyboard reset unimplemented.\n");
- default:
- panic("Unknown keyboard command %#02x.\n", data);
- }
- return hasData();
-}
-
-bool
-X86ISA::PS2Mouse::processData(uint8_t data)
-{
- if (lastCommand != NoCommand) {
- switch(lastCommand) {
- case SetResolution:
- DPRINTF(I8042, "Mouse resolution set to %d.\n", data);
- resolution = data;
- ack();
- lastCommand = NoCommand;
- break;
- case SampleRate:
- DPRINTF(I8042, "Mouse sample rate %d samples "
- "per second.\n", data);
- sampleRate = data;
- ack();
- lastCommand = NoCommand;
- break;
- default:
- panic("Not expecting data for a mouse command.\n");
- }
- return hasData();
- }
- switch (data) {
- case Scale1to1:
- DPRINTF(I8042, "Setting mouse scale to 1:1.\n");
- status.twoToOne = 0;
- ack();
- break;
- case Scale2to1:
- DPRINTF(I8042, "Setting mouse scale to 2:1.\n");
- status.twoToOne = 1;
- ack();
- break;
- case SetResolution:
- DPRINTF(I8042, "Setting mouse resolution.\n");
- lastCommand = SetResolution;
- ack();
- break;
- case GetStatus:
- DPRINTF(I8042, "Getting mouse status.\n");
- ack();
- bufferData((uint8_t *)&(status), 1);
- bufferData(&resolution, sizeof(resolution));
- bufferData(&sampleRate, sizeof(sampleRate));
- break;
- case ReadData:
- panic("Reading mouse data unimplemented.\n");
- case ResetWrapMode:
- panic("Resetting mouse wrap mode unimplemented.\n");
- case WrapMode:
- panic("Setting mouse wrap mode unimplemented.\n");
- case RemoteMode:
- panic("Setting mouse remote mode unimplemented.\n");
- case ReadID:
- DPRINTF(I8042, "Mouse ID requested.\n");
- ack();
- bufferData(ID, sizeof(ID));
- break;
- case SampleRate:
- DPRINTF(I8042, "Setting mouse sample rate.\n");
- lastCommand = SampleRate;
- ack();
- break;
- case DisableReporting:
- DPRINTF(I8042, "Disabling data reporting.\n");
- status.enabled = 0;
- ack();
- break;
- case EnableReporting:
- DPRINTF(I8042, "Enabling data reporting.\n");
- status.enabled = 1;
- ack();
- break;
- case DefaultsAndDisable:
- DPRINTF(I8042, "Disabling and resetting mouse.\n");
- sampleRate = 100;
- resolution = 4;
- status.twoToOne = 0;
- status.enabled = 0;
- ack();
- break;
- case Resend:
- panic("Mouse resend unimplemented.\n");
- case Reset:
- DPRINTF(I8042, "Resetting the mouse.\n");
- sampleRate = 100;
- resolution = 4;
- status.twoToOne = 0;
- status.enabled = 0;
- ack();
- bufferData(&BatSuccessful, sizeof(BatSuccessful));
- bufferData(ID, sizeof(ID));
- break;
- default:
- warn("Unknown mouse command %#02x.\n", data);
- nack();
- break;
- }
- return hasData();
-}
-
-
Tick
X86ISA::I8042::read(PacketPtr pkt)
{
if (addr == dataPort) {
uint8_t data = readDataOut();
//DPRINTF(I8042, "Read from data port got %#02x.\n", data);
- pkt->set<uint8_t>(data);
+ pkt->setLE<uint8_t>(data);
} else if (addr == commandPort) {
//DPRINTF(I8042, "Read status as %#02x.\n", (uint8_t)statusReg);
- pkt->set<uint8_t>((uint8_t)statusReg);
+ pkt->setLE<uint8_t>((uint8_t)statusReg);
} else {
panic("Read from unrecognized port %#x.\n", addr);
}
{
assert(pkt->getSize() == 1);
Addr addr = pkt->getAddr();
- uint8_t data = pkt->get<uint8_t>();
+ uint8_t data = pkt->getLE<uint8_t>();
if (addr == dataPort) {
statusReg.commandLast = 0;
switch (lastCommand) {
case NoCommand:
- if (keyboard.processData(data)) {
- writeData(keyboard.getData(), false);
- }
+ keyboard->hostWrite(data);
+ if (keyboard->hostDataAvailable())
+ writeData(keyboard->hostRead(), false);
break;
case WriteToMouse:
- if (mouse.processData(data)) {
- writeData(mouse.getData(), true);
- }
+ mouse->hostWrite(data);
+ if (mouse->hostDataAvailable())
+ writeData(mouse->hostRead(), true);
break;
case WriteCommandByte:
commandByte = data;
"mouse output buffer\" command.\n", data);
writeData(data, true);
break;
+ case WriteKeyboardOutputBuff:
+ DPRINTF(I8042, "Got data %#02x for \"Write "
+ "keyboad output buffer\" command.\n", data);
+ writeData(data, false);
+ break;
+ case WriteOutputPort:
+ DPRINTF(I8042, "Got data %#02x for \"Write "
+ "output port\" command.\n", data);
+ panic_if(bits(data, 0) != 1, "Reset bit should be 1");
+ // Safe to ignore otherwise
+ break;
default:
panic("Data written for unrecognized "
"command %#02x\n", lastCommand);
case ReadOutputPort:
panic("i8042 \"Read output port\" command not implemented.\n");
case WriteOutputPort:
- warn("i8042 \"Write output port\" command not implemented.\n");
lastCommand = WriteOutputPort;
+ break;
case WriteKeyboardOutputBuff:
- warn("i8042 \"Write keyboard output buffer\" "
- "command not implemented.\n");
lastCommand = WriteKeyboardOutputBuff;
+ break;
case WriteMouseOutputBuff:
DPRINTF(I8042, "Got command to write to mouse output buffer.\n");
lastCommand = WriteMouseOutputBuff;
}
void
-X86ISA::I8042::serializeOld(CheckpointOut &cp)
+X86ISA::I8042::serialize(CheckpointOut &cp) const
{
- uint8_t statusRegData = statusReg.__data;
- uint8_t commandByteData = commandByte.__data;
-
SERIALIZE_SCALAR(dataPort);
SERIALIZE_SCALAR(commandPort);
- SERIALIZE_SCALAR(statusRegData);
- SERIALIZE_SCALAR(commandByteData);
+ SERIALIZE_SCALAR(statusReg);
+ SERIALIZE_SCALAR(commandByte);
SERIALIZE_SCALAR(dataReg);
SERIALIZE_SCALAR(lastCommand);
- mouse.serialize("mouse", cp);
- keyboard.serialize("keyboard", cp);
}
void
X86ISA::I8042::unserialize(CheckpointIn &cp)
{
- uint8_t statusRegData;
- uint8_t commandByteData;
-
UNSERIALIZE_SCALAR(dataPort);
UNSERIALIZE_SCALAR(commandPort);
- UNSERIALIZE_SCALAR(statusRegData);
- UNSERIALIZE_SCALAR(commandByteData);
+ UNSERIALIZE_SCALAR(statusReg);
+ UNSERIALIZE_SCALAR(commandByte);
UNSERIALIZE_SCALAR(dataReg);
UNSERIALIZE_SCALAR(lastCommand);
- mouse.unserialize("mouse", cp);
- keyboard.unserialize("keyboard", cp);
-
- statusReg.__data = statusRegData;
- commandByte.__data = commandByteData;
-}
-
-void
-X86ISA::PS2Keyboard::serialize(const std::string &base, CheckpointOut &cp)
-{
- paramOut(cp, base + ".lastCommand", lastCommand);
- int bufferSize = outBuffer.size();
- paramOut(cp, base + ".outBuffer.size", bufferSize);
- uint8_t *buffer = new uint8_t[bufferSize];
- for (int i = 0; i < bufferSize; ++i) {
- buffer[i] = outBuffer.front();
- outBuffer.pop();
- }
- arrayParamOut(cp, base + ".outBuffer.elts", buffer,
- bufferSize*sizeof(uint8_t));
- delete[] buffer;
-}
-
-void
-X86ISA::PS2Keyboard::unserialize(const std::string &base, CheckpointIn &cp)
-{
- paramIn(cp, base + ".lastCommand", lastCommand);
- int bufferSize;
- paramIn(cp, base + ".outBuffer.size", bufferSize);
- uint8_t *buffer = new uint8_t[bufferSize];
- arrayParamIn(cp, base + ".outBuffer.elts", buffer,
- bufferSize*sizeof(uint8_t));
- for (int i = 0; i < bufferSize; ++i) {
- outBuffer.push(buffer[i]);
- }
- delete[] buffer;
-}
-
-void
-X86ISA::PS2Mouse::serialize(const std::string &base, CheckpointOut &cp)
-{
- uint8_t statusData = status.__data;
- paramOut(cp, base + ".lastCommand", lastCommand);
- int bufferSize = outBuffer.size();
- paramOut(cp, base + ".outBuffer.size", bufferSize);
- uint8_t *buffer = new uint8_t[bufferSize];
- for (int i = 0; i < bufferSize; ++i) {
- buffer[i] = outBuffer.front();
- outBuffer.pop();
- }
- arrayParamOut(cp, base + ".outBuffer.elts", buffer,
- bufferSize*sizeof(uint8_t));
- delete[] buffer;
- paramOut(cp, base + ".status", statusData);
- paramOut(cp, base + ".resolution", resolution);
- paramOut(cp, base + ".sampleRate", sampleRate);
-}
-
-void
-X86ISA::PS2Mouse::unserialize(const std::string &base, CheckpointIn &cp)
-{
- uint8_t statusData;
- paramIn(cp, base + ".lastCommand", lastCommand);
- int bufferSize;
- paramIn(cp, base + ".outBuffer.size", bufferSize);
- uint8_t *buffer = new uint8_t[bufferSize];
- arrayParamIn(cp, base + ".outBuffer.elts", buffer,
- bufferSize*sizeof(uint8_t));
- for (int i = 0; i < bufferSize; ++i) {
- outBuffer.push(buffer[i]);
- }
- delete[] buffer;
- paramIn(cp, base + ".status", statusData);
- paramIn(cp, base + ".resolution", resolution);
- paramIn(cp, base + ".sampleRate", sampleRate);
-
- status.__data = statusData;
}
X86ISA::I8042 *
projects / gem5.git / blobdiff