Add ECC508 for reading/writing config, lock status, locking and serial number

Author: sandeepmistry

src/utility/ECC508.cpp

@@ -29,6 +29,37 @@ void ECC508Class::end()
   _wire->end();
 }
 
+String ECC508Class::serialNumber()
+{
+  String result = (char*)NULL;
+  byte sn[12];
+
+  if (!read(0, 0, &sn[0], 4)) {
+    return result;
+  }
+
+  if (!read(0, 2, &sn[4], 4)) {
+    return result;
+  }
+
+  if (!read(0, 3, &sn[8], 4)) {
+    return result;
+  }
+
+  result.reserve(18);
+
+  for (int i = 0; i < 8; i++) {
+    byte b = sn[i];
+
+    if (b < 16) {
+      result += "0";
+    }
+    result += String(b, HEX);
+  }
+
+  return result;
+}
+
 int ECC508Class::random(byte data[], size_t length)
 {
   if (!wakeup()) {
@@ -140,6 +171,64 @@ int ECC508Class::ecSign(int slot, const byte message[], byte signature[])
   return 1;
 }
 
+int ECC508Class::locked()
+{
+  byte config[4];
+
+  if (!read(0, 0x15, config, sizeof(config))) {
+    return 0;
+  }
+
+  if (config[2] == 0x00 && config[3] == 0x00) {
+    return 1; // locked
+  }
+
+  return 0;
+}
+
+int ECC508Class::writeConfiguration(const byte data[])
+{
+  // skip first 16 bytes, they are not writable
+  for (int i = 16; i < 128; i += 4) {
+    if (i == 84) {
+      // not writable
+      continue;
+    }
+
+    if (!write(0, i / 4, &data[i], 4)) {
+      return 0;
+    }
+  }
+
+  return 1;
+}
+
+int ECC508Class::readConfiguration(byte data[])
+{
+  for (int i = 0; i < 128; i += 32) {
+    if (!read(0, i / 4, &data[i], 32)) {
+      return 0;
+    }
+  }
+
+  return 1;
+}
+
+int ECC508Class::lock()
+{
+  // lock config
+  if (!lock(0)) {
+    return 0;
+  }
+
+  // lock data and OTP
+  if (!lock(1)) {
+    return 0;
+  }
+
+  return 1;
+}
+
 int ECC508Class::wakeup()
 {
   _wire->beginTransmission(0x00);
@@ -288,6 +377,100 @@ int ECC508Class::sign(int slot, byte signature[])
   return 1;
 }
 
+int ECC508Class::read(int zone, int address, byte buffer[], int length)
+{
+  if (!wakeup()) {
+    return 0;
+  }
+
+  if (length != 4 && length != 32) {
+    return 0;
+  }
+
+  if (length == 32) {
+    zone |= 0x80;
+  }
+
+  if (!sendCommand(0x02, zone, address)) {
+    return 0;
+  }
+
+  delay(1);
+
+  if (!receiveResponse(buffer, length)) {
+    return 0;
+  }
+
+  delay(1);
+  idle();
+
+  return length;
+}
+
+int ECC508Class::write(int zone, int address, const byte buffer[], int length)
+{
+  uint8_t status;
+
+  if (!wakeup()) {
+    return 0;
+  }
+
+  if (length != 4 && length != 32) {
+    return 0;
+  }
+
+  if (length == 32) {
+    zone |= 0x80;
+  }
+
+  if (!sendCommand(0x12, zone, address, buffer, length)) {
+    return 0;
+  }
+
+  delay(26);
+
+  if (!receiveResponse(&status, sizeof(status))) {
+    return 0;
+  }
+
+  delay(1);
+  idle();
+
+  if (status != 0) {
+    return 0;
+  }
+
+  return 1;
+}
+
+int ECC508Class::lock(int zone)
+{
+  uint8_t status;
+
+  if (!wakeup()) {
+    return 0;
+  }
+
+  if (!sendCommand(0x17, 0x80 | zone, 0x0000)) {
+    return 0;
+  }
+
+  delay(32);
+
+  if (!receiveResponse(&status, sizeof(status))) {
+    return 0;
+  }
+
+  delay(1);
+  idle();
+
+  if (status != 0) {
+    return 0;
+  }
+
+  return 1;
+}
+
 int ECC508Class::sendCommand(uint8_t opcode, uint8_t param1, uint16_t param2, const byte data[], size_t dataLength)
 {
   byte command[8 + dataLength]; // 1 for type, 1 for length, 1 for opcode, 1 for param1, 2 for param2, 2 for crc

src/utility/ECC508.h

@@ -13,6 +13,8 @@ class ECC508Class
   int begin();
   void end();
 
+  String serialNumber();
+
   int random(byte data[], size_t length);
 
   int generatePrivateKey(int slot, byte publicKey[]);
@@ -21,6 +23,11 @@ class ECC508Class
   int ecdsaVerify(const byte message[], const byte signature[], const byte pubkey[]);
   int ecSign(int slot, const byte message[], byte signature[]);
 
+  int locked();
+  int writeConfiguration(const byte data[]);
+  int readConfiguration(byte data[]);
+  int lock();
+
 private:
   int wakeup();
   int sleep();
@@ -31,6 +38,10 @@ class ECC508Class
   int verify(const byte signature[], const byte pubkey[]);
   int sign(int slot, byte signature[]);
 
+  int read(int zone, int address, byte buffer[], int length);
+  int write(int zone, int address, const byte buffer[], int length);
+  int lock(int zone);
+
   int sendCommand(uint8_t opcode, uint8_t param1, uint16_t param2, const byte data[] = NULL, size_t dataLength = 0);
   int receiveResponse(void* response, size_t length);
   uint16_t crc16(const byte data[], size_t length);