fwupdate.h File Reference

Tenstorrent firmware update API. More...

#include <stdbool.h>
#include <zephyr/device.h>
#include <zephyr/drivers/gpio.h>
#include <tenstorrent/tt_boot_fs.h>

Go to the source code of this file.

Functions
int	tt_fwupdate_init (const struct device *dev, struct gpio_dt_spec mux)
	Set the external flash device and set the passed spi mux (if not null) to allow communication with the spi.
int	tt_fwupdate_complete (void)
	Called on the completion of the fwupdate operation, disables the spi mux if initialized in tt_fwupdate_init
int	tt_fwupdate (const char *tag, bool dry_run, bool reboot)
	Search for, verify, and apply firmware updates.
int	tt_fwupdate_confirm (void)
	Confirm that the current firmware has booted successfully.
int	tt_fwupdate_flash_image (const tt_boot_fs_fd *fd)
	Flash the image described by the provided boot filesystem file descriptor.
int	tt_fwupdate_is_confirmed (void)
	Check if the currently running firmware has been confirmed.
int	tt_fwupdate_validate_fd (const tt_boot_fs_fd *fd)
	Validate the provided boot filesystem file descriptor.
int	tt_fwupdate_validate_image (const tt_boot_fs_fd *fd)
	Validate the image described by the provided boot filesystem file descriptor.

Detailed Description

Tenstorrent firmware update API.

Function Documentation

tt_fwupdate()

int tt_fwupdate	(	const char *	tag,
		bool	dry_run,
		bool	reboot )

Search for, verify, and apply firmware updates.

Note

if a firmware update is applied successfully and reboot is true, then this function does not return.

Parameters

tag	The tag (name) of the update image in the flash filesystem.
dry_run	Only verify data and operations. Do not write to flash or reboot.
reboot	If true, reboot after the update has been successfully written.

Return values

0	on success, if no firmware update is needed.
1	on success, if a firmware update was applied and a reboot is required.
-EINVAL	if an argument is invalid.
-EIO	if an I/O error occurs.
-ENOENT	if the image is invalid an image named tag cannot be found.
-ENODEV	if the current slot cannot be determined or a device is not ready.

tt_fwupdate_complete()

int tt_fwupdate_complete

(

void

)

Called on the completion of the fwupdate operation, disables the spi mux if initialized in tt_fwupdate_init

Return values

0	on success, if the spi mux was able to be set

tt_fwupdate_confirm()

int tt_fwupdate_confirm

(

void

)

Confirm that the current firmware has booted successfully.

Return values

0	on success.
-EIO	if an I/O erorr occurs.

tt_fwupdate_flash_image()

int tt_fwupdate_flash_image

(

const tt_boot_fs_fd *

fd

)

Flash the image described by the provided boot filesystem file descriptor.

Note

This function does not validate the image. Please use tt_fwupdate_validate_image first.

Parameters

fd	A pointer to the file descriptor for the desired image.

Returns

0 if the image described by fd is valid.

Return values

-EINVAL	if fd is NULL.
-ENOENT	if the image is invalid.
-EIO	if an I/O error occurs.
-EFBIG	if the image is too large to fit in the slot.

tt_fwupdate_init()

int tt_fwupdate_init	(	const struct device *	dev,
		struct gpio_dt_spec	mux )

Set the external flash device and set the passed spi mux (if not null) to allow communication with the spi.

Parameters

dev	The pointer to the external flash device to use.
mux	The spi mux to set and disable on start and completion of the fw update operations.

Return values

0	on success, if the spi mux was able to be set

tt_fwupdate_is_confirmed()

int tt_fwupdate_is_confirmed

(

void

)

Check if the currently running firmware has been confirmed.

Return values

0	if the currently running firmware has not been confirmed.
1	if the currently running firmware has been confirmed.
-EIO	if an I/O erorr occurs.

tt_fwupdate_validate_fd()

int tt_fwupdate_validate_fd

(

const tt_boot_fs_fd *

fd

)

Validate the provided boot filesystem file descriptor.

Parameters

fd	A pointer to the file descriptor to validate.

Return values

0	if fd is valid.
-EINVAL	if fd is NULL.
-ENOENT	if fd is invalid.
-EIO	if an I/O error occurs.

tt_fwupdate_validate_image()

int tt_fwupdate_validate_image

(

const tt_boot_fs_fd *

fd

)

Validate the image described by the provided boot filesystem file descriptor.

Parameters

fd	A pointer to the file descriptor for the desired image.

Returns

0 if the image described by fd is valid.

Return values

-EINVAL	if fd is NULL.
-ENOENT	if the image is invalid.
-EIO	if an I/O error occurs.