update_transport.h File Reference

Update transport interface. More...

#include "core/cboot_error.h"
#include "os_port.h"

Go to the source code of this file.

Classes
struct	UpdateTransport
	Update Transport definition. More...

Typedefs
typedef cboot_error_t(*	TransportInit) (void)
	Transport initialization function.
typedef cboot_error_t(*	TransportPoll) (TransportState *state)
	Get Transport state function.
typedef cboot_error_t(*	TransportRead) (uint8_t *data, size_t size, size_t *received)
	Read Data from Transport function.
typedef cboot_error_t(*	TransportClose) (void)
	Transport de-initialization function.

Enumerations
enum	TransportState { TRANSPORT_IDLE = 0 , TRANSPORT_ACTIVE , TRANSPORT_COMPLETE , TRANSPORT_FAILED }
	Transport state. More...

Detailed Description

Update transport interface.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2021-2026 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneBOOT Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.6.6

Enumeration Type Documentation

TransportState

enum TransportState

Transport state.

Enumerator
TRANSPORT_IDLE	No transfer started.
TRANSPORT_ACTIVE	Transfer in progress.
TRANSPORT_COMPLETE	Transfer finished.
TRANSPORT_FAILED	Transfer failed.