Opcodes for communication. More...

#include <cstdint>
#include <string>
#include <map>

Include dependency graph for opcodes.hpp:

Classes
struct	TCmdOpCode
	Defines an opcode to run. More...

class	OpCode
	Opcode Manager Class. More...

Typedefs
typedef std::map< kCmdOpCodeEnum, TCmdOpCode >	TCmdOpCodeMap
	Type of opcodes group (map). More...

Enumerations
enum	kCmdParamValueEnum { kCmdParamOff = 0x00 , kCmdParamOn = 0x01 }
	Enumeration of the param values. More...

enum	kCmdResponseValueEnum { kCmdResponseNok = 0xA0 , kCmdResponseOk = 0xA1 }
	Enumeration of the response values. More...

enum	kCmdOpCodeEnum { kCmdNop = 0x00 , kCmdVddCtrl = 0x01 , kCmdVddSetV = 0x02 , kCmdVddGetV = 0x03 , kCmdVddGetDuty = 0x04 , kCmdVddGetCal = 0x05 , kCmdVddInitCal = 0x06 , kCmdVddSaveCal = 0x07 , kCmdVddOnVpp = 0x08 , kCmdVppCtrl = 0x11 , kCmdVppSetV = 0x12 , kCmdVppGetV = 0x13 , kCmdVppGetDuty = 0x14 , kCmdVppGetCal = 0x15 , kCmdVppInitCal = 0x16 , kCmdVppSaveCal = 0x17 , kCmdVppOnA9 = 0x18 , kCmdVppOnA18 = 0x19 , kCmdVppOnCE = 0x1A , kCmdVppOnOE = 0x1B , kCmdVppOnWE = 0x1C , kCmdBusCE = 0x21 , kCmdBusOE = 0x22 , kCmdBusWE = 0x23 , kCmdBusAddrClr = 0x31 , kCmdBusAddrInc = 0x32 , kCmdBusAddrSet = 0x33 , kCmdBusAddrSetB = 0x34 , kCmdBusAddrSetW = 0x35 , kCmdBusDataClr = 0x41 , kCmdBusDataSet = 0x42 , kCmdBusDataSetW = 0x43 , kCmdBusDataGet = 0x44 , kCmdBusDataGetW = 0x45 , kCmdDeviceSetTwp = 0x81 , kCmdDeviceSetTwc = 0x82 , kCmdDeviceConfigure = 0x83 , kCmdDeviceSetupBus = 0x84 , kCmdDeviceRead = 0x85 , kCmdDeviceWrite = 0x86 , kCmdDeviceWriteSector = 0x87 , kCmdDeviceVerify = 0x88 , kCmdDeviceBlankCheck = 0x89 , kCmdDeviceGetId = 0x8A , kCmdDeviceErase = 0x8B , kCmdDeviceUnprotect = 0x8C , kCmdDeviceProtect = 0x8D }
	Enumeration of the OpCodes. More...

enum	kCmdDeviceOperationEnum { kCmdDeviceOperationReset = 0x00 , kCmdDeviceOperationRead = 0x01 , kCmdDeviceOperationProg = 0x02 }
	Enumeration of the Device Operations. More...

enum	kCmdDeviceAlgorithmEnum { kCmdDeviceAlgorithmUnknown = 0x00 , kCmdDeviceAlgorithmSRAM = 0x04 , kCmdDeviceAlgorithmEPROM = 0x08 , kCmdDeviceAlgorithmEEPROM28C64 = 0x0C , kCmdDeviceAlgorithmEEPROM28C256 = 0x0D , kCmdDeviceAlgorithmFlash28F = 0x10 , kCmdDeviceAlgorithmFlashSST28SF = 0x11 , kCmdDeviceAlgorithmFlashAm28F = 0x12 , kCmdDeviceAlgorithmFlashI28F = 0x13 }
	Enumeration of the Device Algorithms. More...

Detailed Description

Opcodes for communication.

Author: Robson Martins (https://www.robsonmartins.com)

Typedef Documentation

◆ TCmdOpCodeMap

typedef std::map<kCmdOpCodeEnum, TCmdOpCode> TCmdOpCodeMap

Type of opcodes group (map).

Enumeration Type Documentation

◆ kCmdOpCodeEnum

enum kCmdOpCodeEnum

Enumeration of the OpCodes.

Enumerator
kCmdNop	OPCODE / NOP : Opcode NOP.
kCmdVddCtrl	OPCODE / VDD : Opcode VDD Control On/Off. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVddSetV	OPCODE / VDD : Opcode VDD Set Voltage. The parameter (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVddGetV	OPCODE / VDD : Opcode VDD Get Voltage. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVddGetDuty	OPCODE / VDD : Opcode VDD Get PWM Duty Cycle. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVddGetCal	OPCODE / VDD : Opcode VDD Get Calibration. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVddInitCal	OPCODE / VDD : Opcode VDD Init Calibration.
kCmdVddSaveCal	OPCODE / VDD : Opcode VDD Save Calibration. The parameter (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVddOnVpp	OPCODE / VDD : Opcode VDD on VPP. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppCtrl	OPCODE / VPP : Opcode VPP Control On/Off. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppSetV	OPCODE / VPP : Opcode VPP Set Voltage. The parameter (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVppGetV	OPCODE / VPP : Opcode VPP Get Voltage. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVppGetDuty	OPCODE / VPP : Opcode VPP Get PWM Duty Cycle. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVppGetCal	OPCODE / VPP : Opcode VPP Get Calibration. The result (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVppInitCal	OPCODE / VPP : Opcode VPP Init Calibration.
kCmdVppSaveCal	OPCODE / VPP : Opcode VPP Save Calibration. The parameter (two bytes) represents the value. MSB is integer part. LSB is fractional part.
kCmdVppOnA9	OPCODE / VPP : Opcode VPP on A9. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppOnA18	OPCODE / VPP : Opcode VPP on A18. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppOnCE	OPCODE / VPP : Opcode VPP on CE. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppOnOE	OPCODE / VPP : Opcode VPP on OE. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdVppOnWE	OPCODE / VPP : Opcode VPP on WE. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdBusCE	OPCODE / BUS : Opcode CE Ctrl. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdBusOE	OPCODE / BUS : Opcode OE Ctrl. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdBusWE	OPCODE / BUS : Opcode WE Ctrl. The parameter (one byte) indicates on/off. See also kCmdParamValueEnum
kCmdBusAddrClr	OPCODE / BUS : Opcode Address Clear.
kCmdBusAddrInc	OPCODE / BUS : Opcode Address Increment.
kCmdBusAddrSet	OPCODE / BUS : Opcode Address Set. The parameter (four bytes) represents the address (MSB up to LSB).
kCmdBusAddrSetB	OPCODE / BUS : Opcode Address Set Byte. The parameter (one byte) represents the address.
kCmdBusAddrSetW	OPCODE / BUS : Opcode Address Set Word. The parameter (two bytes) represents the address (MSB up to LSB).
kCmdBusDataClr	OPCODE / BUS : Opcode Data Clear.
kCmdBusDataSet	OPCODE / BUS : Opcode Data Set Byte. The parameter (one byte) represents the data.
kCmdBusDataSetW	OPCODE / BUS : Opcode Data Set Word. The parameter (two bytes) represents the data (MSB up to LSB).
kCmdBusDataGet	OPCODE / BUS : Opcode Data Get Byte. The result (one byte) represents the data.
kCmdBusDataGetW	OPCODE / BUS : Opcode Data Get Word. The result (two bytes) represents the data (MSB up to LSB).
kCmdDeviceSetTwp	OPCODE / DEVICE : Opcode Device Set tWP. The parameter (four bytes) represents the tWP value in microseconds.
kCmdDeviceSetTwc	OPCODE / DEVICE : Opcode Device Set tWC. The parameter (four bytes) represents the tWC value in microseconds.
kCmdDeviceConfigure	OPCODE / DEVICE : Opcode Device Configure. The first parameter (one byte) represents the device algorithm. The second parameter (one byte) represents the flags, and follows the table: +----------------------+ \|Bit\| Description \| \| 0 \| Skip Write 0xFF \| \| 1 \| Prog with VPP On \| \| 2 \| VPP/~OE Pin \| \| 3 \| ~PGM/~CE Pin \| \| 4 \| PGM positive \| \| 5 \| 16-bit mode \| +----------------------+ See also kCmdDeviceAlgorithmEnum
kCmdDeviceSetupBus	OPCODE / DEVICE : Opcode Device Setup Bus. The parameter (one byte) represents the operation, and follows the table: +------------------------------+ \|Operation\| Description \| \| 0x00 \| Reset Bus \| \| 0x01 \| Prepare to Read \| \| 0x02 \| Prepare to Program \| +------------------------------+ See also kCmdDeviceOperationEnum
kCmdDeviceRead	OPCODE / DEVICE : Opcode Device Read Byte/Word buffer and Increment Address. The parameter (one byte) represents the buffer size, in bytes. The return is [size] bytes. MSB first.
kCmdDeviceWrite	OPCODE / DEVICE : Opcode Device Write Byte/Word buffer, verify and Increment Address. The first parameter (one byte) represents the buffer size, in bytes. The second parameter ([size] bytes) is the data to write. MSB first.
kCmdDeviceWriteSector	OPCODE / DEVICE : Opcode Device Write Byte/Word sector, verify and Increment Address. The first parameter (two bytes) represents the sector size, in bytes. The following are data to write (size is specified). MSB first.
kCmdDeviceVerify	OPCODE / DEVICE : Opcode Device Verify Byte/Word buffer and Increment Address. The first parameter (one byte) represents the buffer size, in bytes. The second parameter ([size] bytes) is the data to verify. MSB first.
kCmdDeviceBlankCheck	OPCODE / DEVICE : Opcode Device Check if Byte/Word buffer is Blank and Increment Address. The parameter (one byte) represents the buffer size, in bytes.
kCmdDeviceGetId	OPCODE / DEVICE : Opcode Device Get ID. The result (four bytes) represents Manufacturer/Device ID, following the table: +--------------------------------------------+ \|Response \| Description \| \| First (MSB)/Second (LSB) \| Manufacurer ID \| \| Third (MSB)/Fourth (LSB) \| Device ID \| +--------------------------------------------+
kCmdDeviceErase	OPCODE / DEVICE : Opcode Device Erase.
kCmdDeviceUnprotect	OPCODE / DEVICE : Opcode Device Unprotect.
kCmdDeviceProtect	OPCODE / DEVICE : Opcode Device Protect.

◆ kCmdDeviceOperationEnum

enum kCmdDeviceOperationEnum

Enumeration of the Device Operations.

See also: kCmdDeviceSetupBus

Enumerator
kCmdDeviceOperationReset	CMD / DEVICE : Defines a operation Reset.
kCmdDeviceOperationRead	CMD / DEVICE : Defines a operation Read.
kCmdDeviceOperationProg	CMD / DEVICE : Defines a operation Program.

◆ kCmdDeviceAlgorithmEnum

enum kCmdDeviceAlgorithmEnum

Enumeration of the Device Algorithms.

See also: kCmdDeviceConfigure

Enumerator
kCmdDeviceAlgorithmUnknown	CMD / DEVICE : Defines an unknown algorithm.
kCmdDeviceAlgorithmSRAM	CMD / DEVICE : Defines an algorithm SRAM.
kCmdDeviceAlgorithmEPROM	CMD / DEVICE : Defines an algorithm EPROM 27.
kCmdDeviceAlgorithmEEPROM28C64	CMD / DEVICE : Defines an algorithm EEPROM 28C64.
kCmdDeviceAlgorithmEEPROM28C256	CMD / DEVICE : Defines an algorithm EEPROM 28C256 or upper.
kCmdDeviceAlgorithmFlash28F	CMD / DEVICE : Defines an algorithm Flash 28F.
kCmdDeviceAlgorithmFlashSST28SF	CMD / DEVICE : Defines an algorithm Flash SST28SF.
kCmdDeviceAlgorithmFlashAm28F	CMD / DEVICE : Defines an algorithm Flash Am28F.
kCmdDeviceAlgorithmFlashI28F	CMD / DEVICE : Defines an algorithm Flash i28F.

Classes

Typedefs