doc(todo): Explain some TODOs a bit more

Signed-off-by: Christian Svensson <[email protected]>

Author: Christian Svensson

pkg/core/core_test.go

@@ -1,6 +1,8 @@
 package core
 
-// TODO
+// TODO: The plan here is to extract some RPC responses and test the parsing
+// against these known drives to ensure long-term compatibility.
+// Here are some Discovery Level0 bytes to get started.
 
 // Samsung EVO 860:
 // d0raw: [0 0 0 144 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 16 12 17 0 0 0 0 0 0 0 0 0 0 0 0 2 16 12 31 0 0 0 0 0 0 0 0 0 0 0 0 3 16 28 1 0 0 0 0 0 0 0 0 0 2 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 2 2 16 12 0 0 0 9 0 160 0 0 0 0 0 1 2 3 16 16 16 4 0 1 0 0 4 0 9 0 0 0 0 0 0 0]

pkg/core/table/locking.go

@@ -277,8 +277,6 @@ func Locking_Set(s *core.Session, row *LockingRow) error {
 	// TODO: Add these columns
 	//mc.StartOptionalParameter(3, "RangeStart")
 	//mc.StartOptionalParameter(4, "RangeLength")
-	//mc.StartOptionalParameter(5, "ReadLockEnabled")
-	//mc.StartOptionalParameter(6, "WriteLockEnabled")
 
 	if row.ReadLockEnabled != nil {
 		mc.StartOptionalParameter(5, "ReadLockEnabled")
@@ -303,7 +301,6 @@ func Locking_Set(s *core.Session, row *LockingRow) error {
 	}
 
 	// TODO: Add these columns
-	//mc.StartOptionalParameter(8, "WriteLocked")
 	//mc.StartOptionalParameter(9, "LockOnReset")
 	//mc.StartOptionalParameter(10, "ActiveKey")
 

pkg/locking/locking.go

@@ -134,7 +134,7 @@ func NewSession(cs *core.ControlSession, lmeta *LockingSPMeta, auth LockingSPAut
 		return nil, err
 	}
 
-	// TODO: Fill l.Authorities
+	// TODO: Fill l.Authorities with known users for admin actions
 	return l, nil
 }
 
@@ -243,18 +243,22 @@ func initializeEnterprise(s *core.Session, d0 *core.Level0Discovery, ic *initial
 	if err == nil {
 		lmeta.MSID = msidPin
 	}
-	// TODO: Take ownership
-	// TODO: lockdown
+	// TODO: Implement take ownership for enterprise if activated in initializeConfig.
+	// The spec should explain what is needed.
+	// TODO: If initializeConfig wants WithHardended, implement relevant
+	// FIPS recommendations.
 	return nil
 }
 
 func initializeOpalFamily(s *core.Session, d0 *core.Level0Discovery, ic *initializeConfig, lmeta *LockingSPMeta) error {
-	// TODO: Verify with C_PIN behavior and Block SID
+	// TODO: Verify with C_PIN behavior and Block SID - no need to burn PIN tries
+	// if we can say that MSID will not work.
 	msidPin, err := table.Admin_C_PIN_MSID_GetPIN(s)
 	if err == nil {
 		lmeta.MSID = msidPin
 	}
 	// TODO: Take ownership (*before* Activate to ensure that the PINs are copied)
+	// This is explained in the spec.
 	lcs, err := table.Admin_SP_GetLifeCycleState(s, core.LockingSP)
 	if err != nil {
 		return err
@@ -274,7 +278,8 @@ func initializeOpalFamily(s *core.Session, d0 *core.Level0Discovery, ic *initial
 		return fmt.Errorf("unsupported life cycle state on locking SP: %v", lcs)
 	}
 
-	// TODO: lockdown
+	// TODO: If initializeConfig wants WithHardended, implement relevant
+	// FIPS recommendations.
 	return nil
 }
 

pkg/locking/range.go

@@ -45,7 +45,7 @@ type Range struct {
 	ReadLocked  bool
 	WriteLocked bool
 
-	//LockOnReset SomeType TODO
+	//LockOnReset SomeType TODO: Create this type from spec
 }
 
 func fillRanges(s *core.Session, l *LockingSP) error {
@@ -86,8 +86,8 @@ func fillRanges(s *core.Session, l *LockingSP) error {
 			r.ReadLocked = *lr.ReadLocked
 			r.WriteLocked = *lr.WriteLocked
 		}
-		// TODO: Users
-		// TODO: LockOnReset
+		// TODO: Enumerate users with permissions on this range
+		// TODO: Fill the LockOnReset property
 		l.Ranges = append(l.Ranges, r)
 	}
 	return nil