From patchwork Tue Jan 26 11:17:44 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Storm, Christian" X-Patchwork-Id: 1431612 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2a00:1450:4864:20::438; helo=mail-wr1-x438.google.com; envelope-from=swupdate+bncbdd6bwv65qpbbyptx6aamgqeqvxt34a@googlegroups.com; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20161025 header.b=QXegIPRc; dkim-atps=neutral Received: from mail-wr1-x438.google.com (mail-wr1-x438.google.com [IPv6:2a00:1450:4864:20::438]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4DQ40n1KNcz9sCq for ; Tue, 26 Jan 2021 22:15:50 +1100 (AEDT) Received: by mail-wr1-x438.google.com with SMTP id l7sf5260137wrp.1 for ; Tue, 26 Jan 2021 03:15:50 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1611659746; cv=pass; d=google.com; s=arc-20160816; b=c2jXTrqtPqe0/AhgGrZ35k84wgg3Dgyruad1PgREM5Z+ctJ0V5MbK0FY3JY0A6h7/m 6vadNLPZmFc9/Ehe9W19pGqlN7rp2Mzcj9bECwDtds/cYuN42c/8Pdt1ZsehE+UhqgLB LzXKHfejMw30o56hzc7SfAjlfVsvtU+/7w10n4hfaAzuJFNaXp8MNQXEwY+l03vOF695 49dBqU5m0R6S6W8ypzqKJRBmvm+g0wxAJQYvKyo8qgBKxM4DaFkQKck0flJZd899lgSM f6OPXbMu1vdPOa5vvzxRugEYHa/mWwjR9mGo5eHEtsrlS+78itUi2so18PDJD69JarKQ zaiA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:mime-version:message-id:date :subject:cc:to:from:sender:dkim-signature; bh=Wqg+I+G4qzj677074JsNF1bPEtbWkMWCn8XHm0oCEOg=; b=L1+Pqz2fQ6Yr2PlU+0pgiy34SnBDpCqzUPkaV9m5vfNZ+39TM3mAML33vls6koYHxv STE46su3f5vzeE14/5gOBH2b93WCqmW/JnIF5FPlguxBeSLkMP4SGnYLoRe+0n4PfiLD m5dZoH5ihWUAc/oCA4AZUJSiXE+zZSfMpGYaJ7lfNW+/ptoQ1K/R3xV8wNmXRPo8z++D qOIFvpf/DDomOwdS8IlUtKMH8bGrJg32YGhmwGxw0sC7dKYyws4tDJNJcKu2uheXoGIZ RMeg91wtG99/RzEsxOz+9IuCV1fhfTkXAl36qe7FFL7uqz62OQHtNVB7f0eWOcwnLeri eWNA== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=pass (google.com: domain of christian.storm@siemens.com designates 192.35.17.28 as permitted sender) smtp.mailfrom=christian.storm@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:mime-version :x-original-sender:x-original-authentication-results:precedence :mailing-list:list-id:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=Wqg+I+G4qzj677074JsNF1bPEtbWkMWCn8XHm0oCEOg=; b=QXegIPRcZXQU2Or9xpNxANy2LuLjP92s8jV+5TpQlXBrWeKvY4G0nc3bL2pZIFnkU3 9GZ13ri/6ndU4gpuJPMLFazJovGLa5rkNvteTbb3v9T6rkPaRLwHx3+OsCAIBzf0pGnO J7oxmIRFy0xcALlD84zlShHwGJOrAtG79tK20q/yQI/2kjI3tR5B/DmB+qXALAKXf4YN bRxu8CT3oz/V7C9gprB/moZJZ8GXuRyxMbARvR0tQ1rqFWXx8eLourp3/zRp/oSmVnbO a9nUcZQvBYAWu5QdJUYSw2QlWOc177LiwyWkxBrw5gw33ntjpt+QlM+0X3QgWvoO6qNs NmkQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=sender:x-gm-message-state:from:to:cc:subject:date:message-id :mime-version:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:x-spam-checked-in-group:list-post :list-help:list-archive:list-subscribe:list-unsubscribe; bh=Wqg+I+G4qzj677074JsNF1bPEtbWkMWCn8XHm0oCEOg=; b=saprVrr8u3HbimMcdlvNbIm39e4ZAZZDLj5Tb6TbSFDhXbhS71h8GYPp0v6S6V23ZL bFFBcdlaSupLd37AcnaUBaq/AipymxKlN1PJ1L2tF7+uPQup8jxr+NihJwzFA3+T5qMq QyrP+aOB4EaTnwJf7sGeryn/KRIJ/ZXDRHIOoH7ANkP+cNVniadm7YhBJhsjHi6rfknJ ZeSLdVHclSPQxaKUiQm4XSa3a1pBa0J6aWa43S7WF6koeKjzQWA6y24ZZVG5EvxqiODp o5UdpaQdkPiZ8Vr3o0fXNocbLXkipDUZQZakkpAGsIq8XxkKREL64bmSyZr5cnJWaqWQ VK8g== Sender: swupdate@googlegroups.com X-Gm-Message-State: AOAM532IvsGHaIecX9UWnLAMSOdK0stvoE7it586Zip33ClUdXphwS30 EM6zXR5GRGE91mycu5q0MNE= X-Google-Smtp-Source: ABdhPJxGWYvDQENQri68KEdUqONlGPnZHrVysh2HhRE0LSjkrQuIjd1UEVa9sFZz0Nw7DD1aK4YGdw== X-Received: by 2002:a7b:cbc7:: with SMTP id n7mr4222437wmi.106.1611659746191; Tue, 26 Jan 2021 03:15:46 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a7b:c8c8:: with SMTP id f8ls1098269wml.3.gmail; Tue, 26 Jan 2021 03:15:45 -0800 (PST) X-Received: by 2002:a1c:a593:: with SMTP id o141mr4237389wme.92.1611659745265; Tue, 26 Jan 2021 03:15:45 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1611659745; cv=none; d=google.com; s=arc-20160816; b=LumY1CoMQyn6hTUHbkEN4FkIbk9Vv/5kGvZsGtLDM/G6kJJpxOBRVjK+BBCf4wl9iD 61WyyEt9U5PCftza0zRCvILhJS5yKSc9uwfV6QkXtEBAlb91SRn2lsBn0018Pg0Wtsvz QEDF8F/cMYieS3AuLz4UFKOphQdXuP8RfWzOBmtZgXu3aW3DEgPuoRUbEJ/czrBK2fcN /vlBDYXFNCIZlzNqqWFKon6LPYH7Cp9x8ntPcdcYols19/tnh8Zzz/iDVcVoaLmUddPv 4S33T5mbzA5pC+FxFWR3TXCwsyhZup3bmEydyLi4Hd6K6pnWv00zviiiBP03W8hfCwqR V4Yg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from; bh=Wcsc31WF1wLAzeKWlfcM5MKsJUsBP9YFs+QLHZk5nGM=; b=IlCXlb/H/SGpwFCG5koZ8ql/rmaVljq0xOd+uXgHPbFXJVWaYNnyBeriP+gsEB1xxt V9wUuk83vLe0d40QSBd3c167rSXR+d0NNwkaO/I/tUAwC2l61AYPVcpnMGVrUlye83II sfu7E+BwIpts5pg81PQlgJ7qObKJvUnyWlNhoOxF/THTb9LvNQ9TO/uAV9VXV3iHDIpb P6xDeC3FyWSiHdHHatt20hKLk8ZFzUs27pYG9bUF7TPV5wHlhz/TdE6HghX9bQEQo/kE upDqzBaQQlTwUzXi0ttIiisFiB9zoZ5sYg8C9KwJex4i/HuFdaJjFqLtd9B97EZO/Nkw CpDQ== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of christian.storm@siemens.com designates 192.35.17.28 as permitted sender) smtp.mailfrom=christian.storm@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Received: from goliath.siemens.de (goliath.siemens.de. [192.35.17.28]) by gmr-mx.google.com with ESMTPS id s3si458161wrt.5.2021.01.26.03.15.45 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 26 Jan 2021 03:15:45 -0800 (PST) Received-SPF: pass (google.com: domain of christian.storm@siemens.com designates 192.35.17.28 as permitted sender) client-ip=192.35.17.28; Received: from mail1.siemens.de (mail1.siemens.de [139.23.33.14]) by goliath.siemens.de (8.15.2/8.15.2) with ESMTPS id 10QBFiNh011362 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Tue, 26 Jan 2021 12:15:44 +0100 Received: from MD1ZFJVC.ad001.siemens.net ([167.87.7.200]) by mail1.siemens.de (8.15.2/8.15.2) with ESMTP id 10QBFiQR021886; Tue, 26 Jan 2021 12:15:44 +0100 From: Christian Storm To: swupdate@googlegroups.com Cc: Christian Storm Subject: [swupdate] [PATCH] state: Update code comments on persistent state handling Date: Tue, 26 Jan 2021 12:17:44 +0100 Message-Id: <20210126111744.10844-1-christian.storm@siemens.com> X-Mailer: git-send-email 2.30.0 MIME-Version: 1.0 X-Original-Sender: christian.storm@siemens.com X-Original-Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of christian.storm@siemens.com designates 192.35.17.28 as permitted sender) smtp.mailfrom=christian.storm@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , Signed-off-by: Christian Storm Reviewed-by: Stefano Babic --- include/state.h | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/include/state.h b/include/state.h index c0f1175..4ddb607 100644 --- a/include/state.h +++ b/include/state.h @@ -19,17 +19,12 @@ /* (Persistent) Update State Management Functions. * - * Suricatta may persistently store the update status to communicate it to the - * server instance after, e.g., a successful reboot into the new firmware. The - * `{save,read,reset}_state()` functions are called by a server implementation - * to persistently manage the update state via, e.g., U-Boot's environment. + * The SWUpdate core or a module such as suricatta may want to persistently + * store the update status to communicate it to the server instance after, + * e.g., a successful reboot into the new firmware. + * The `{save,get}_state()` functions are called to manage the update status + * via, e.g., U-Boot's environment. * - * Besides suricatta, this mechanism is also used by SWUpdate's core for - * setting an update transaction marker, i.e., the bootloader environment - * variable BOOTVAR_TRANSACTION (default: "recovery_status") is set to - * "in_progress" prior to an update operation and either unset or set to - * "failed" after the update operation, depending on whether an sw-description's - * "bootloader_transaction_marker" property is true which is the default. */ typedef enum {