ps2device.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
 
#include "fabglconf.h"
#include "ps2controller.h"
 
 
namespace fabgl {
 
 
 
enum class PS2DeviceType {
  UnknownPS2Device,             
  OldATKeyboard,                
  MouseStandard,                
  MouseWithScrollWheel,         
  Mouse5Buttons,                
  MF2KeyboardWithTranslation,   
  M2Keyboard,                   
};
 
 
 
class PS2Device {
 
public:
 
  PS2DeviceType identify() { PS2DeviceType result; send_cmdIdentify(&result); return result; };
 
  bool lock(int timeOutMS);
 
  void unlock();
 
  bool parityError();
 
  bool syncError();
 
  bool CLKTimeOutError();
 
  bool sendCommand(uint8_t cmd, uint8_t expectedReply);
 
  void sendCommand(uint8_t cmd);
 
  void suspendPort();
 
  void resumePort();
 
  uint16_t deviceID()    { return m_deviceID; }
 
 
protected:
 
  PS2Device();
  ~PS2Device();
 
  void quickCheckHardware();
 
  void begin(int PS2Port);
 
  int dataAvailable();
  int getData(int timeOutMS);
 
  void requestToResendLastByte();
 
  bool send_cmdLEDs(bool numLock, bool capsLock, bool scrollLock);
  bool send_cmdEcho();
  bool send_cmdGetScancodeSet(uint8_t * result);
  bool send_cmdSetScancodeSet(uint8_t scancodeSet);
  bool send_cmdIdentify(PS2DeviceType * result);
  bool send_cmdDisableScanning();
  bool send_cmdEnableScanning();
  bool send_cmdTypematicRateAndDelay(int repeatRateMS, int repeatDelayMS);
  bool send_cmdSetSampleRate(int sampleRate);
  bool send_cmdSetDefaultParams();
  bool send_cmdReset();
  bool send_cmdSetResolution(int resolution);
  bool send_cmdSetScaling(int scaling);
 
private:
 
  int16_t           m_PS2Port;
  int16_t           m_cmdTimeOut;
  int16_t           m_cmdSubTimeOut;
  uint16_t          m_deviceID;       // read by send_cmdIdentify()
};
 
 
 
struct PS2DeviceLock {
  PS2DeviceLock(PS2Device * PS2Device) : m_PS2Device(PS2Device) { m_PS2Device->lock(-1); }
  ~PS2DeviceLock() { m_PS2Device->unlock(); }
 
  PS2Device * m_PS2Device;
};
 
 
 
 
 
 
 
} // end of namespace