Diff: OneWire_Masters/ISha256MacCoprocessor.hpp

Revision:

48:6f9208ae280e

Parent:

33:a4c015046956

Child:

49:36954b62f503

--- a/OneWire_Masters/ISha256MacCoprocessor.hpp	Thu Apr 07 10:26:26 2016 -0500
+++ b/OneWire_Masters/ISha256MacCoprocessor.hpp	Thu Apr 07 11:26:20 2016 -0500
@@ -6,6 +6,7 @@
 
 #include "array.hpp"
 
+/// Interface for SHA-256 coprocessors compatible with the DS28E15/22/25 family.
 class ISha256MacCoprocessor
 {
 public:
@@ -23,10 +24,30 @@
   typedef array<std::uint8_t, 12> AuthMacData;
   typedef array<std::uint8_t, 12> SlaveSecretData;
   
-  virtual CmdResult setMasterSecret(const Secret & secret) = 0;
+  /// Set Master Secret in coprocessor.
+  /// @param[in] masterSecret New master secret to set.
+  virtual CmdResult setMasterSecret(const Secret & masterSecret) = 0;
+  
+  /// Compute Slave Secret in the coprocessor.
+  /// @note Uses the previously set Master Secret in computation.
+  /// @param[in] devicePage Page data stored on device.
+  /// @param[in] deviceScratchpad Scratchpad data stored on device.
+  /// @param[in] slaveSecretData Variable data field used in calculation.
+  virtual CmdResult computeSlaveSecret(const DevicePage & devicePage, const DeviceScratchpad & deviceScratchpad, const SlaveSecretData & slaveSecretData) = 0;
+  
+  /// Compute Write MAC
+  /// @note Uses the previously computed Slave Secret in computation.
+  /// @param[in] writeMacData Variable data fields used in calculation.
+  /// @param[out] mac The computed MAC.
   virtual CmdResult computeWriteMac(const WriteMacData & writeMacData, Mac & mac) const = 0;
+  
+  /// Compute Authentication MAC
+  /// @note Uses the previously computed Slave Secret in computation.
+  /// @param[in] devicePage Page data stored on device.
+  /// @param[in] challege Random challenge for device.
+  /// @param[in] authMacData Variable data fields used in calculation.
+  /// @param[out] mac The computed MAC.
   virtual CmdResult computeAuthMac(const DevicePage & devicePage, const DeviceScratchpad & challenge, const AuthMacData & authMacData, Mac & mac) const = 0;
-  virtual CmdResult computeSlaveSecret(const DevicePage & devicePage, const DeviceScratchpad & deviceScratchpad, const SlaveSecretData & slaveSecretData) = 0;
 };
 
-#endif
\ No newline at end of file
+#endif