fix cargo-cross

fix the missing Openssl dependency that caused a build failure if cargo
cross was used. Updated the README to reflect the changes

GH-52 implemented os_update

Added logic to execute a os_update

streaming_data_service: removed receiverReader

* Removed our custom receiverReader and replaced it with a tokio variant
* moved transfer_context to its own file
* amount of bytes written is now returned in the status object of
  `TransferContext`
* other small improvements

firmware_runner: resolve technical debt pt.3

Prevent tokio::io::copy from stalling by making the reader exhaustive

Update README.md

remove the package parameter. which is obsoleted now.

persistency: during shutdown only write if changed

Only write the binary persistency file if it was actually dirty

firmware_runner: resolve technical debt pt.2

* In this commit the custom copy function is replaced with a
plain `tokio::io::copy`. This function is more efficient as in that it
can copy with arbitrary read/write sizes and doesnt enforce
`.write_exact`.
* An `CrCReader` is introduced that hooks into the `AsyncRead` reads to
  calculate a crc checksum.
* This copy flow can still be aborted with an "cancel" signal

firmware_runner: resolve technical debt

Condensed writing/reading mechanism inside `firmware_runner` to one
function, `copy_with_crc`. Next iteration a better implementation is
desired for reporting process.

restructure bmcd workspace

* flattened the workspace by squasing `tpi_rs` into `bmcd`. `tpi_rs` was
  the remainders of a library that was statically compiled into the
  legacy bmc C application.
* moved around some files. Tried to group modules and files by feature.

remove c_interface module

This module was an temporary glue layer in order to develop new code in
the legacy bmc binary. Since we have a new bmc daemon, this code can be
buried.

 flash_service: Generalize logic

 This commit extracts flash related logic out of the flash_service
 until we are left with a generic service that can receive large
 binary data.

fix regression in test-suite

persistency: maturing component

* Implemented a fallback mechanism when the database binary is
  corrupted. In this case the binary will be omitted and overwritten
  with an default store on successive write-backs of the store to disk
* Improved fatal error messages on erroneous `.get()` and `.set()`
  calls.
* Created a new config file item: `write_timeout`. Controls the write
  timeout of the persistency. More information inside
  `default_config.yaml`

CI: add cargo-deny

* Verify use of FOSS licenses.
* added copyright header to **/*.rs files

Merge pull request #53 from turing-machines/feature/serial

tpi_rs: add serial handlers

Merge branch 'master' into feature/serial

 Gh-10 rework pin controller

Rework to accommodate changes in the Linux subsystem by #49.

serial: rework the ownership

The serial workers synchronize communication by:
* a channel for writes.
* shares the 'RingBuffer' implementation for reads.

 Implement token and basic authentication

NOTE: this Service is not resilient against brute-force attacks in such
it does not implement rate limiting on authentication nor authorization
requests.

* Uses Linux users to authorize requests.
* no authorization roles or scopes are implemented yet.
* token based authentication is implemented with the Redfish session
  login authentication in mind. That is, when we would implement Redfish
  it should be easy to append the current implementation
* token timeout gets reset on every use of the token.
* basic authentication: The authentication service expects a
  'Authorization' header containing the following format: 'Basic <base64
  encoded as <username:password>>'

run `cargo fmt`

serial: add `encoding` parameter

serial: move `RingBuffer` to its own module

flash_service: stability and improvements

* added a API call so a client can ask the current status of the
  `FlashService`
* fixes regarding cancelling of the node flash
* cleanup of code

Node reset: implement simulated reset

Node reset GPIO's are not connected on the board. Therefore remove
related logic and implement a simulated reset by toggling the power of
a given node.

legacy API: support USB routes to BMC

added "usb_boot" operation

* split the usbboot pin functionality from the usb configuration and
  gave it its separate routine call.
* usb_boot pin is now exposed over the API via opt=set&type=usb_boot

tpi_rs: add serial handlers

Fixes #22

expose version info over port 80

added node reset to API

bmcd: expose API "info" endpoint

This is a poor man's way to introduce a versioning in the 'BMC API'.
Version info can be retrieved by calling "/bmc/api/info". This endpoint
is exposed both on the HTTP and HTTPS port.

Secondly this commit contains some small updates on the response
handling in the legacy module.

legacy_response: use Cow

Small code improvement to use std's Cow instead of our own 'Owned' enum
variant.

enable tls

TLS is added and enforced. the bmcd requires a `--certificate` and
`--private-key` argument in order to run.

A server is binded onto the old `80` port, that will redirect traffic to
443

app_persistency: improvements and review comments

app_persistency: update documentation

app_persistency: new implementation

This commit aims to improve the internal bmcd persistency:
* Its more lean, no sqlite implementation anymore
* Implemented a writeback mechanism that tries to reduce the amount of
  writes to the file system (can be disabled all together)
* read cache

The implementation is based on the following assumptions:
* This store will only be used for internal application state.
* We expect that it will contain a maximum of approximately 10 settings.
* Settings are not updated frequently. Users will setup their system
  once and no changes can occur in weeks .

The solution aims to reduce the amount of writes to the filesystem.
Secondly, no additional database driver is used. The key/value store
gets written as raw bytes. All to make sure the actual space on the
filesystem stays as small as possible.

Since the key/value store is not expected to go over 1 LEB, the whole
key/value store gets written on a update, even when only one value
changed.

furthermore the api of the persistency store got extended,
differentiating between try_* and get/set. Non-try functions will panic
on serialization errors, or when the given key is not registered.

A persistency component gets initialized using the `PersistencyBuilder`.
It enforces users to declare all the keys that are used by the
application. This is to make sure to limit the possibilities of using
wrong keys.

Note 1: There is no migration implemented from the old sqlite implementation.
This means that users will lose their settings when upgrading to this
version. At the moment of writing, there are only 2 low impact key/value
pairs, which does not justify writing migration code.

Note 2: There is no protection implemented for trans serializing
different types. Its up to the developer to make sure to use the correct
data types.

this commit fixes #107, https://github.com/turing-machines/BMC-Firmware/issues/107

dependabot: disable until further notice

Currently its creating more noise than it actually helps to update
dependencies. We will continue updating them manually

 Cargo.toml: update dependencies

 * set MSRV to 1.70.0
 * updated .lock file
 * moved crate.io patch to top-level Cargo.toml

bmcd: listen on IPv6 & increase KeepAlive

Prevent the TCP connection from closing during a flashing process. When
the receive buffer is full, byte chunk requests will be blocked until
new space becomes available. This caused connection resets, resulting in
an abort of the flashing process. This happens, for example, during the
configuration phase of the node which typically takes longer as 5 sec.
default keep-alive for HTTP1.1 was 5 sec. This CL align sets the
keep-alive timeout to the value of the underlaying OS.

rockusb_fwudate: Update bootmode detection

After discussion with the maintainers, decided is to keep the Bootmode
detection logic local to this project. There is no generic solution
possible that works for all rockusb devices. Detection is based on
behavior of the loader that is installed on the rockchip device, no
spec exists that guarantees a certain behavior of this loader.
see https://github.com/collabora/rockchiprs/pull/22

Updated the rockusb dependency to the main branch, as one of the latest
patches are required.

flash_application: progress printing improvements

Apply suggestions from code review

incorporate review comments

flash_service: implement receive timeout.

Given a aborted file transfer. If a client wants to do a new transfer
request, reset the flash service only when a given timeout is reached.
Its assumed that the aborted transfer will never complete anymore after
this timeout.

legacy_response: dont encode status code in message

 cancel flash_service

 Add cancel token to abort a flash operation to one of the nodes. the
 process gets interrupted, and some cleanup is performed if necessary.

flash_service: fixes

* make use of the actix-web router for "flashing" requests. Prevents
  false positives while routing
* fixed overflow in progress printer

FlashService: fixes

legacy_response: impl actix responder

io.rs: implemented a ReceiverReader

This struct wraps a receiver object and exposes the `AsyncRead` trait
for it. This is the last piece that connects the `FlashService` with the
 actual firmware writer.

flash_service: implement file streaming handler

Added a handler in the 'bmcd' that:
* receives a firmware image over the http API endpoint
* buffers these image chunks
* async write chunks to a given node

update README.md

Added building from repo section

c_interface: fix omitted start of event_listener

write_to_device: improvements on read & write img

enforced 2 requirements:
* Only full buffers are read and written to a device
* The exact amount of image bytes are written. This implies that the
  buffer size of the last write will be trimmed.

Note: there is an implicit requiment hidden in this code. The buffersize
that is written needs to be a multiple of the sector size of the device
that is written to.

 Concentrate flashing related code

 This is an attempt to resolve some technical debt related to flashing
 images to nodes. Split off the `flash_node` to a new file called
 `flash_application`. Moved flashing related definitions and datatypes
 to firmware_update.

into_legacy_response: move out to seperate file

Create README.md

bmcd: IntoLegacyResponse

Implemented boilerplate code to transform `anyhow::Result` and
`HttpResponses` into `LegacyResponses`. The goal of the `LegacyResponse`
type is to enforce a specific layout of the response body. Because
legacy responders must specify a `LegacyResponse` before it gets
transformed into a `HttpResponse`.

Changed API port from 8080 to 80. The former is a more industry comform
port. However to not break legacy tools we are stuck with port 80 port
for the `legacy API`

Refactored out the Arc wrapper around `BmcApplication`. moved the
event_listener to a seperate module. This should make the relation
between the `EventListener` and `BmcApplication` more visible.

calculate_checksum: fix bug

This issue occurs when the written image size is not equal to a product
of the internal read buffer size. Improved the code so that the exact
amount of bytes are read when calculating a checksum. This means the
that the last read will be trimmed to match the file size. Instead of
reading a full buffer.

bugfix: power led missing

fixes #115, https://github.com/turing-machines/BMC-Firmware/issues/115

bmcd: log exit

firmware_update: remove opt-out features

rockusb_fwudate: remove unneeded const generic

Small code change with minor effect

StdTransportWrapper: rename variables

* Rename the buffer variables related to AsyncRead to make the code better
readable.
* Convert the buffer.try_borrow_mut into a borrow_mut. As Self is a
  mutable variable, we cannot endup in a scenario where the buffer is
  already borrowed by another call.
* Added small code comments on the Transport trait objects

StdFwUpdateTransport: fix clippy errors

StdTransportWrapper: fix buffer copy

Secondly, the `calc_file_checksum` function is hiding the error Result
in case of an error respones. Made it early return instead on Error.

rockusb_fwudate: rk3588 spl_loader

Load an spl that inits ram and setup the usb flashing environment when
The device is booted into MaskRom mode. Without this step, writing a
image to the device will fail.

This commit makes use of rockusb branch of svenrademakers. Hopefully
the patch associated with this CL will be submitted upstream soon.

usbboot: rename verify_one_device

renamed to extract_one_device as intent changed

firmware_update: FlashingErrorExt

Created trait that maps a `Result<T, E>` into a
`Result<T, FlashingError>` using the logging pipe.

This commit aims to increase code clarity by concentrating generic
logic.

Cargo.toml: update versions of tokio, log & serde

firmware_update: resolve technical debt

The goal is to decouple and concentrate generic logic from the two
firmware update mechanisms currently present in the code-base. This
should make it more easy for new devs to append new transport and
therefore support more devices.

This commit also updates the rockusb dependency to the fork containing
fixes so that the RK1 devices work. fixes #45,
https://github.com/turing-machines/BMC-Firmware/issues/45

usbboot: build compatible devices list

revert back to old situation where a list of devices is build. Last
commit was automatically picking the first out of the list. Now,
firmware update will fail if there are more as one device connected to
the BMC.

feature gate fwu modules

added 2 features, "rpi" and "rock" that are enabled by default.
Both pull in additional dependencies and add to binary size. Via this
way there is a convinient way to opt out of these features

bmcd: remove last `unwrap()`

bmcd: set power state of nodes in one function call

bmcd: remove `Mutex` and mutable references to `BmcApplication`

bmcd, lib: add `get_usb_mode()`

bmcd/legacy: add GET methods

bmcd/legacy: add explanations to errors and `Query` type alias

bmcd: begin adding legacy API, with stubs for now

add HTTPS server that serves static files

add common logging crates, enable timestamps for `simple_logger`

move tpi_rs into its own directory, start bmcd

serde: bump to 1.0.180

firmware_update_usb: create match statement of vid_pids

firmware_update_usb: only iterate usb devices once

Small refactoring so usb devices are only iterated once.

tpi_rs: remove unused `async-trait` dependency

bump version to 1.3.0

lib: fix checksum verification failure during flashing

Prior to d8c41c61c ("GH-45 extract raspberry specific to seperate
module"), flashing code would open a device file for writing, write,
open device for reading, read (with cache dropping in-between).

In that change, file handle is reused for writing and subsequent
reading, leading to invalid OoB reads. Fix this by seeking to a start
of file after writing.

lib: fix clippy warnings

bmc_application: small improvement on logging

During firmware upgrade, use the Debug trait to make sure the correct
node id is being printed in a logging statement.

build(deps): bump serde from 1.0.171 to 1.0.175

Bumps [serde](https://github.com/serde-rs/serde) from 1.0.171 to 1.0.175.
- [Release notes](https://github.com/serde-rs/serde/releases)
- [Commits](https://github.com/serde-rs/serde/compare/v1.0.171...v1.0.175)

---
updated-dependencies:
- dependency-name: serde
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

build(deps): bump async-trait from 0.1.71 to 0.1.72

Bumps [async-trait](https://github.com/dtolnay/async-trait) from 0.1.71 to 0.1.72.
- [Release notes](https://github.com/dtolnay/async-trait/releases)
- [Commits](https://github.com/dtolnay/async-trait/compare/0.1.71...0.1.72)

---
updated-dependencies:
- dependency-name: async-trait
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

pin_controller: fix wrong USB_PWEN values breaking USB host mode

Due to a specification + implementation mishap, values for a USB-A
power-controlling pin were inverted, leading to port being disabled when
the opposite was expected. In the future, this should be caught by a
special test runner.

Fixes #15

CI: use clippy-check

The clippy-check github action publishes a report of the workflow
page of a given run in github.

bmc_application: bugfix: power state support legacy tpi

If one node is on, consider the global 'on state' also to be on

rpi_fwupdate: bug-fix: AsyncRead was connected wrong

bmc_application: fix bug in updating power state.

Update the global on/off state only when all nodes are on/off.

build(deps): bump sqlx from 0.7.0 to 0.7.1

Bumps [sqlx](https://github.com/launchbadge/sqlx) from 0.7.0 to 0.7.1.
- [Changelog](https://github.com/launchbadge/sqlx/blob/main/CHANGELOG.md)
- [Commits](https://github.com/launchbadge/sqlx/compare/v0.7.0...v0.7.1)

---
updated-dependencies:
- dependency-name: sqlx
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

build(deps): bump anyhow from 1.0.71 to 1.0.72

Bumps [anyhow](https://github.com/dtolnay/anyhow) from 1.0.71 to 1.0.72.
- [Release notes](https://github.com/dtolnay/anyhow/releases)
- [Commits](https://github.com/dtolnay/anyhow/compare/1.0.71...1.0.72)

---
updated-dependencies:
- dependency-name: anyhow
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Implemented RK1 fwupdate support.

This work fixes #45:
    https://github.com/turing-machines/BMC-Firmware/issues/45

Implemented discovery of an RK1 module as well as Implemented the
firmware update read/write trait. Note that its implemented in a
blocking way. #12 is opened to track any work to improve on this.

This implementation expects the RK1 to be put into maskedROM mode.
Writing to eMMC starts from sector 0.