1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
* Author: Christian Storm
* Copyright (C) 2017, Siemens AG
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
#pragma once
#include <stdbool.h>
#include <stdint.h>
#include <swupdate_status.h>
#ifdef __cplusplus
extern "C" {
#endif
#define PRINFOSIZE 2048
typedef enum progress_cause {
CAUSE_NONE,
CAUSE_REBOOT_MODE,
CAUSE_DRY_RUN_MODE,
} progress_cause_t;
extern char* SOCKET_PROGRESS_PATH;
/*
* Versioning of API
* it is defined as
* bits 31..24 : unused, set to 0
* bits 23..16 : Major Version
* bits 15..8 : Minor version
* bits 7..0 : small changes not relevant for compatibility
*
* The following policy is followed:
* - changes in minor version mean that the API was enhanced and it has
* new features, but it is compatible with the older. It is suggested
* that clients are updated, but they still work.
* - changes in major mean an incompatibility and clients do not work anymore
*/
#define PROGRESS_API_MAJOR 2
#define PROGRESS_API_MINOR 0
#define PROGRESS_API_PATCH 0
#define PROGRESS_API_VERSION ((PROGRESS_API_MAJOR & 0xFFFF) << 16 | \
(PROGRESS_API_MINOR & 0xFF) << 8 | \
(PROGRESS_API_PATCH & 0xFF))
/*
* Message sent via progress socket.
* Data is sent in LE if required.
*/
struct progress_msg {
uint32_t apiversion; /* API Version for compatibility check */
uint32_t status; /* Update Status (Running, Failure) */
uint32_t dwl_percent; /* % downloaded data */
unsigned long long dwl_bytes; /* total of bytes to be downloaded */
uint32_t nsteps; /* No. total of steps */
uint32_t cur_step; /* Current step index */
uint32_t cur_percent; /* % in current step */
char cur_image[256]; /* Name of image to be installed */
char hnd_name[64]; /* Name of running handler */
uint32_t source; /* Interface that triggered the update */
uint32_t infolen; /* Len of data valid in info */
char info[PRINFOSIZE]; /* additional information about install */
} __attribute__ ((__packed__));;
#define PROGRESS_CONNECT_ACK_MAGIC "ACK"
struct progress_connect_ack {
uint32_t apiversion; /* API Version for compatibility check */
char magic[4]; /* null-terminated string */
};
char *get_prog_socket(void);
/* Standard function to connect to progress interface */
int progress_ipc_connect(bool reconnect);
/*
* In case more as an instance of SWUpdate is running, this allows to select
* which should be taken
*/
int progress_ipc_connect_with_path(const char *socketpath, bool reconnect);
/* Retrieve messages from progress interface (blocking and non-blocking) */
int progress_ipc_receive(int *connfd, struct progress_msg *msg);
int progress_ipc_receive_nb(int *connfd, struct progress_msg *msg);
#ifdef __cplusplus
} // extern "C"
#endif
|
