github.com/google/trillian-examples@v0.0.0-20240520080811-0d40d35cef0e/binary_transparency/firmware/cmd/flash_tool/devices/device.go (about)

     1  // Copyright 2020 Google LLC. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package devices
    16  
    17  import (
    18  	"github.com/google/trillian-examples/binary_transparency/firmware/api"
    19  )
    20  
    21  // ErrNeedsInit error type indicates that the device is as yet uninitialised
    22  // and the device may need to be "force" flashed.
    23  type ErrNeedsInit = error
    24  
    25  // Device represents an updatable device.
    26  //
    27  // Drivers for individual devices would be bound to this interface, which
    28  // allows a generic flash tool to control the secure update process.
    29  type Device interface {
    30  	// DeviceCheckpoint returns the log checkpoint note used during the last firmware update.
    31  	DeviceCheckpoint() ([]byte, error)
    32  	// ApplyUpdate applies the provided update to the device.
    33  	ApplyUpdate(api.UpdatePackage) error
    34  }