16#include "os_io_seph_ux.h"
19#include "os_helpers.h"
26#define PAGE_NB_ELEMENTS_BITS 3
27#define GET_PAGE_NB_ELEMENTS(pageData) ((pageData) &0x07)
28#define SET_PAGE_NB_ELEMENTS(nbElements) ((nbElements) &0x07)
30#define PAGE_FLAG_BITS 1
31#define GET_PAGE_FLAG(pageData) (((pageData) &0x08) >> 3)
32#define SET_PAGE_FLAG(flag) (((flag) &0x01) << 3)
34#define PAGE_DATA_BITS (PAGE_NB_ELEMENTS_BITS + PAGE_FLAG_BITS)
35#define PAGES_PER_UINT8 (8 / PAGE_DATA_BITS)
36#define SET_PAGE_DATA(pageIdx, pageData) \
37 (pagesData[pageIdx / PAGES_PER_UINT8] = pageData \
38 << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS))
40#define MAX_PAGE_NB 256
41#define MAX_MODAL_PAGE_NB 32
44#define STARTING_CONTENT localContentsList[0]
45#define FINISHING_CONTENT localContentsList[1]
48#define QRCODE_NB_MAX_LINES 3
50#define QRCODE_REDUCED_ADDR_LEN 128
53#define ADDR_VERIF_NB_PAIRS 3
56#define sharedContext genericContext.sharedCtx
57#define keypadContext sharedContext.keypad
58#define reviewWithWarnCtx sharedContext.reviewWithWarning
59#define choiceWithDetailsCtx sharedContext.choiceWithDetails
62#define W3C_DESCRIPTION_MAX_LEN 128
69#define RISKY_OPERATION (1 << 6)
76#define NO_THREAT_OPERATION (1 << 7)
89 ADDRESS_QRCODE_BUTTON_TOKEN,
100 CHOICE_DETAILS_TOKEN,
102 QUIT_TIPBOX_MODAL_TOKEN,
103 WARNING_CHOICE_TOKEN,
105 DISMISS_WARNING_TOKEN,
106 DISMISS_DETAILS_TOKEN,
107 FIRST_WARN_BAR_TOKEN,
118typedef struct DetailsContext_s {
121 uint8_t currentPairIdx;
125 const char *nextPageStart;
128typedef struct AddressConfirmationContext_s {
132} AddressConfirmationContext_t;
135typedef struct KeypadContext_s {
138 uint8_t pinMinDigits;
139 uint8_t pinMaxDigits;
145typedef struct ReviewWithWarningContext_s {
150 const char *reviewTitle;
151 const char *reviewSubTitle;
152 const char *finishTitle;
157 uint8_t securityReportLevel;
159} ReviewWithWarningContext_t;
161typedef struct ChoiceWithDetailsContext_s {
166} ChoiceWithDetailsContext_t;
170 SHARE_CTX_REVIEW_WITH_WARNING,
171 SHARE_CTX_CHOICE_WITH_DETAILS,
172} SharedContextUsage_t;
179 KeypadContext_t keypad;
181 ReviewWithWarningContext_t reviewWithWarning;
182 ChoiceWithDetailsContext_t choiceWithDetails;
184 SharedContextUsage_t usage;
188 USE_CASE_GENERIC = 0,
190} GenericContextType_t;
193 GenericContextType_t type;
194 uint8_t spinnerPosition;
196 int8_t currentContentIdx;
197 uint8_t currentContentElementNb;
198 uint8_t currentElementIdx;
199 bool hasStartingContent;
200 bool hasFinishingContent;
201 const char *detailsItem;
202 const char *detailsvalue;
203 bool detailsWrapping;
204 bool validWarningCtx;
214 SharedContext_t sharedCtx;
225} nbgl_homeAndSettingsContext_t;
230} nbgl_reviewContext_t;
238} nbgl_reviewStreamingContext_t;
241 nbgl_homeAndSettingsContext_t homeAndSettings;
242 nbgl_reviewContext_t review;
243 nbgl_reviewStreamingContext_t reviewStreaming;
244} nbgl_BundleNavContext_t;
250} SecurityReportItem_t;
257static char tmpString[W3C_DESCRIPTION_MAX_LEN];
277static const char *pageTitle;
280#define activeTipBox genericContext.tipBox
284static bool forwardNavOnly;
285static NavType_t navType;
287static DetailsContext_t detailsContext;
290static AddressConfirmationContext_t addressConfirmationContext;
293static GenericContext_t genericContext;
295 localContentsList[3];
296static uint8_t genericContextPagesInfo[MAX_PAGE_NB / PAGES_PER_UINT8];
297static uint8_t modalContextPagesInfo[MAX_MODAL_PAGE_NB / PAGES_PER_UINT8];
300static nbgl_BundleNavContext_t bundleNavContext;
303static const uint8_t nbMaxElementsPerContentType[] = {
320 .icon = &WARNING_ICON,
321 .text =
"Blind signing required",
322 .subText =
"This transaction's details are not fully verifiable. If "
323 "you sign, you could lose all your assets."
326 .icon = &WARNING_ICON,
327 .text =
"Transaction Check unavailable",
331 .icon = &WARNING_ICON,
332 .text =
"Risk detected",
333 .subText =
"This transaction was scanned as risky by Web3 Checks."
336 .icon = &WARNING_ICON,
337 .text =
"Critical threat",
338 .subText =
"This transaction was scanned as malicious by Web3 Checks."
342 .text =
"No threat detected",
343 .subText =
"Transaction Check didn't find any threat, but always "
344 "review transaction details carefully."
354static char reducedAddress[QRCODE_REDUCED_ADDR_LEN];
360static void displayReviewPage(uint8_t page,
bool forceFullRefresh);
361static void displayDetailsPage(uint8_t page,
bool forceFullRefresh);
362static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh);
363static void displayFullValuePage(
const char *backText,
364 const char *aliasText,
366static void displayInfosListModal(
const char *modalTitle,
370static void displaySettingsPage(uint8_t page,
bool forceFullRefresh);
371static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh);
372static void pageCallback(
int token, uint8_t index);
374static void displayAddressQRCode(
void);
376static void modalLayoutTouchCallback(
int token, uint8_t index);
377static void displaySkipWarning(
void);
379static void bundleNavStartHome(
void);
380static void bundleNavStartSettingsAtPage(uint8_t initSettingPage);
381static void bundleNavStartSettings(
void);
383static void bundleNavReviewStreamingChoice(
bool confirm);
385static void displaySecurityReport(uint32_t set);
387static void displayInitialWarning(
void);
391 const char *reviewTitle,
392 const char *reviewSubTitle,
393 const char *finishTitle,
397 bool playNotifSound);
400 const char *reviewTitle,
401 const char *reviewSubTitle,
403 bool playNotifSound);
404static void useCaseHomeExt(
const char *appName,
411static void displayDetails(
const char *tag,
const char *value,
bool wrapping);
413static void reset_callbacks_and_context(
void)
420 onContentAction = NULL;
423 onValidatePin = NULL;
425 memset(&genericContext, 0,
sizeof(genericContext));
429static void genericContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements,
bool flag)
431 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements) + SET_PAGE_FLAG(flag);
433 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
434 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
435 genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
436 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
440static void genericContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements,
bool *flag)
442 uint8_t pageData = genericContextPagesInfo[pageIdx / PAGES_PER_UINT8]
443 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
444 if (nbElements != NULL) {
445 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
448 *flag = GET_PAGE_FLAG(pageData);
453static void modalContextSetPageInfo(uint8_t pageIdx, uint8_t nbElements)
455 uint8_t pageData = SET_PAGE_NB_ELEMENTS(nbElements);
457 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
458 &= ~(0x0F << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS));
459 modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
460 |= pageData << ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
464static void modalContextGetPageInfo(uint8_t pageIdx, uint8_t *nbElements)
466 uint8_t pageData = modalContextPagesInfo[pageIdx / PAGES_PER_UINT8]
467 >> ((pageIdx % PAGES_PER_UINT8) * PAGE_DATA_BITS);
468 if (nbElements != NULL) {
469 *nbElements = GET_PAGE_NB_ELEMENTS(pageData);
476 switch (content->
type) {
500 if (contentIdx < 0 || contentIdx >= genericContents->
nbContents) {
517static void prepareNavInfo(
bool isReview, uint8_t nbPages,
const char *rejectText)
519 memset(&navInfo, 0,
sizeof(navInfo));
522 navInfo.
tuneId = TUNE_TAP_CASUAL;
526 if (isReview ==
false) {
535 = ((navType == STREAMING_NAV) && (nbPages < 2)) ?
false : true;
542 const char *reviewTitle,
543 const char *reviewSubTitle)
545 contentCenter->
icon = icon;
546 contentCenter->
title = reviewTitle;
548 contentCenter->
subText =
"Swipe to review";
551 contentCenter->
padding =
false;
557 if (finishTitle != NULL) {
562 return "Sign transaction";
564 return "Sign message";
566 return "Sign operation";
573 const char *finishTitle)
575 infoLongPress->
text = getFinishTitle(operationType, finishTitle);
576 infoLongPress->
icon = icon;
584 const char *finishTitle)
586 infoButton->
text = getFinishTitle(operationType, finishTitle);
587 infoButton->
icon = icon;
594 UNUSED(operationType);
600static void pageModalCallback(
int token, uint8_t index)
604 if (token == INFOS_TIP_BOX_TOKEN) {
606 displayFullValuePage(activeTipBox.infos.infoTypes[index],
607 activeTipBox.infos.infoContents[index],
608 &activeTipBox.infos.infoExtensions[index]);
611 else if (token == INFO_ALIAS_TOKEN) {
613 displayFullValuePage(genericContext.currentInfos->infoTypes[index],
614 genericContext.currentInfos->infoContents[index],
615 &genericContext.currentInfos->infoExtensions[index]);
619 modalPageContext = NULL;
620 if (token == NAV_TOKEN) {
627 displayDetailsPage(index,
false);
630 if (token == MODAL_NAV_TOKEN) {
637 displayTagValueListModalPage(index,
false);
640 else if (token == QUIT_TOKEN) {
645 else if (token == QUIT_TIPBOX_MODAL_TOKEN) {
647 if (reviewWithWarnCtx.securityReportLevel == 2) {
648 reviewWithWarnCtx.securityReportLevel = 1;
649 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
657 else if (token == SKIP_TOKEN) {
668 else if (token == CHOICE_TOKEN) {
670 if (onModalConfirm != NULL) {
672 onModalConfirm = NULL;
684static void pageCallback(
int token, uint8_t index)
687 if (token == QUIT_TOKEN) {
688 if (onQuit != NULL) {
692 else if (token == CONTINUE_TOKEN) {
693 if (onContinue != NULL) {
697 else if (token == CHOICE_TOKEN) {
698 if (onChoice != NULL) {
699 onChoice((index == 0) ?
true : false);
702 else if (token == ACTION_BUTTON_TOKEN) {
703 if ((index == 0) && (onAction != NULL)) {
706 else if ((index == 1) && (onQuit != NULL)) {
711 else if (token == ADDRESS_QRCODE_BUTTON_TOKEN) {
712 displayAddressQRCode();
715 else if (token == CONFIRM_TOKEN) {
716 if (onChoice != NULL) {
720 else if (token == REJECT_TOKEN) {
721 if (onChoice != NULL) {
725 else if (token == DETAILS_BUTTON_TOKEN) {
726 displayDetails(genericContext.detailsItem,
727 genericContext.detailsvalue,
728 genericContext.detailsWrapping);
730 else if (token == NAV_TOKEN) {
732 if (onQuit != NULL) {
737 if (navType == GENERIC_NAV || navType == STREAMING_NAV) {
738 displayGenericContextPage(index,
false);
740 else if (navType == REVIEW_NAV) {
741 displayReviewPage(index,
false);
744 displaySettingsPage(index,
false);
748 else if (token == NEXT_TOKEN) {
750 displayReviewPage(navInfo.
activePage + 1,
false);
753 displayGenericContextPage(navInfo.
activePage + 1,
false);
756 else if (token == BACK_TOKEN) {
758 displayReviewPage(navInfo.
activePage - 1,
true);
761 displayGenericContextPage(navInfo.
activePage - 1,
false);
764 else if (token == SKIP_TOKEN) {
766 displaySkipWarning();
768 else if (token == VALUE_ALIAS_TOKEN) {
771 if (genericContext.currentPairs != NULL) {
772 pair = &genericContext.currentPairs[genericContext.currentElementIdx + index];
775 pair = genericContext.currentCallback(genericContext.currentElementIdx + index);
779 else if (token == BLIND_WARNING_TOKEN) {
780 reviewWithWarnCtx.isIntro =
false;
781 reviewWithWarnCtx.warning = NULL;
784 else if (token == WARNING_BUTTON_TOKEN) {
786 reviewWithWarnCtx.securityReportLevel = 1;
788 if (reviewWithWarnCtx.warning->predefinedSet) {
789 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
793 if (reviewWithWarnCtx.isIntro) {
794 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->introDetails);
797 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->reviewDetails);
801 else if (token == TIP_BOX_TOKEN) {
803 if (genericContext.validWarningCtx && (reviewWithWarnCtx.warning->predefinedSet != 0)) {
804 reviewWithWarnCtx.securityReportLevel = 1;
805 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
808 displayInfosListModal(activeTipBox.modalTitle, &activeTipBox.infos,
false);
812 if (onContentAction != NULL) {
813 onContentAction(token, index, navInfo.
activePage);
815 if (onControls != NULL) {
816 onControls(token, index);
822static void tickerCallback(
void)
825 if (onQuit != NULL) {
831static void displaySettingsPage(uint8_t page,
bool forceFullRefresh)
835 if ((onNav == NULL) || (onNav(page, &content) ==
false)) {
840 content.
title = pageTitle;
843 content.
tuneId = TUNE_TAP_CASUAL;
848 if (forceFullRefresh) {
857static void displayReviewPage(uint8_t page,
bool forceFullRefresh)
866 if ((onNav == NULL) || (onNav(navInfo.
activePage, &content) ==
false)) {
871 content.
title = NULL;
873 content.
tuneId = TUNE_TAP_CASUAL;
880 if (forwardNavOnly) {
905 if (forceFullRefresh) {
915static const nbgl_content_t *genericContextComputeNextPageParams(uint8_t pageIdx,
917 uint8_t *p_nbElementsInNextPage,
920 int8_t nextContentIdx = genericContext.currentContentIdx;
921 int16_t nextElementIdx = genericContext.currentElementIdx;
922 uint8_t nbElementsInNextPage;
925 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
926 *p_nbElementsInNextPage = nbElementsInNextPage;
931 uint8_t nbElementsInCurrentPage;
933 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
934 nextElementIdx += nbElementsInCurrentPage;
939 if ((nextElementIdx >= genericContext.currentContentElementNb)
940 && (genericContext.currentContentElementNb > 0)) {
950 nextElementIdx -= nbElementsInNextPage;
956 if (nextElementIdx < 0) {
958 nextElementIdx = -nbElementsInNextPage;
964 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
965 p_content = &STARTING_CONTENT;
967 else if ((nextContentIdx == genericContext.genericContents.nbContents)
968 && (genericContext.hasFinishingContent)) {
969 p_content = &FINISHING_CONTENT;
972 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
974 if (p_content == NULL) {
989 if ((nextContentIdx != genericContext.currentContentIdx)
990 || (genericContext.currentContentElementNb == 0)) {
991 genericContext.currentContentIdx = nextContentIdx;
992 genericContext.currentContentElementNb = getContentNbElement(p_content);
994 if (nextElementIdx < 0) {
995 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
1000 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
1002 "Invalid element index %d / %d\n",
1004 genericContext.currentContentElementNb);
1009 genericContext.currentElementIdx = nextElementIdx;
1017static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
1018 uint8_t nbElementsInPage,
1022 uint8_t nextElementIdx = genericContext.currentElementIdx;
1024 pageContent->
title = pageTitle;
1027 pageContent->
tuneId = TUNE_TAP_CASUAL;
1029 pageContent->
type = p_content->
type;
1030 switch (pageContent->
type) {
1082 p_tagValueList = NULL;
1094 genericContext.detailsItem = pair->
item;
1095 genericContext.detailsvalue = pair->
value;
1100 if (p_tagValueList != NULL) {
1101 p_tagValueList->
nbPairs = nbElementsInPage;
1104 p_tagValueList->
pairs
1107 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1109 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1115 p_tagValueList->
pairs = NULL;
1119 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1123 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1139 if ((nextElementIdx + nbElementsInPage)
1151 p_tagValueList->
nbPairs = nbElementsInPage;
1152 p_tagValueList->
pairs
1155 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1157 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1162 genericContext.currentPairs = p_tagValueList->
pairs;
1163 genericContext.currentCallback = p_tagValueList->
callback;
1187 < nextElementIdx + nbElementsInPage)) {
1207 bool isFirstOrLastPage
1211 = (navType == STREAMING_NAV)
1212 ? bundleNavContext.reviewStreaming.operationType
1213 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1216 if (isFirstOrLastPage
1217 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1219 if ((operationType & NO_THREAT_OPERATION)
1228 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1235static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh)
1239 uint8_t nbElementsInPage;
1243 if (navType == STREAMING_NAV) {
1245 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1246 bundleNavContext.reviewStreaming.skipCallback();
1250 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1251 bundleNavReviewStreamingChoice(
true);
1258 pageIdx = navInfo.
nbPages - 1;
1264 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1269 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1270 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1280 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1283 if (p_content == NULL) {
1287 if ((navType != STREAMING_NAV)
1290 if ((pageIdx > 0) && (pageIdx < (navInfo.
nbPages - 1))) {
1302 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1308 if (forceFullRefresh) {
1317static const char *getDetailsPageAt(uint8_t detailsPage)
1320 const char *currentChar = detailsContext.value;
1321 while (page < detailsPage) {
1331 detailsContext.wrapping);
1333 if (currentChar[len] ==
'\n') {
1336 else if (detailsContext.wrapping ==
false) {
1339 currentChar = currentChar + len;
1347static void displayDetailsPage(uint8_t detailsPage,
bool forceFullRefresh)
1351 .nbPages = detailsContext.nbPages,
1353 .quitToken = QUIT_TOKEN,
1354 .navWithButtons.navToken = NAV_TOKEN,
1355 .navWithButtons.quitButton =
true,
1356 .navWithButtons.backButton =
true,
1357 .navWithButtons.quitText = NULL,
1358 .progressIndicator =
false,
1359 .tuneId = TUNE_TAP_CASUAL};
1361 .topRightIcon = NULL,
1362 .tagValueList.nbPairs = 1,
1363 .tagValueList.pairs = ¤tPair,
1364 .tagValueList.smallCaseForValue =
true,
1365 .tagValueList.wrapping = detailsContext.wrapping};
1367 if (modalPageContext != NULL) {
1370 currentPair.
item = detailsContext.tag;
1372 if (detailsPage <= detailsContext.currentPage) {
1374 currentPair.
value = getDetailsPageAt(detailsPage);
1375 forceFullRefresh =
true;
1379 currentPair.
value = detailsContext.nextPageStart;
1381 detailsContext.currentPage = detailsPage;
1392 detailsContext.wrapping);
1395 if (currentPair.
value[len] ==
'\n') {
1398 else if (!detailsContext.wrapping) {
1403 detailsContext.nextPageStart = currentPair.
value + len;
1409 detailsContext.nextPageStart = NULL;
1418 if (forceFullRefresh) {
1427static void displayFullValuePage(
const char *backText,
1428 const char *aliasText,
1431 const char *modalTitle
1432 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1434 genericContext.currentInfos = extension->
infolist;
1435 displayInfosListModal(modalTitle, extension->
infolist,
true);
1438 genericContext.currentTagValues = extension->
tagValuelist;
1443 .withLeftBorder =
true,
1444 .onActionCallback = &modalLayoutTouchCallback,
1445 .tapActionText = NULL};
1447 .separationLine =
false,
1448 .backAndText.token = 0,
1449 .backAndText.tuneId = TUNE_TAP_CASUAL,
1450 .backAndText.text = modalTitle};
1459 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1460 .text2 = extension->explanation,
1471 info =
"ENS names are resolved by Ledger backend.";
1474 info =
"This account label comes from your Address Book in Ledger Wallet.";
1480 genericContext.modalLayout, aliasText, extension->
fullValue, info);
1489static void displayInfosListModal(
const char *modalTitle,
1496 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1497 .navWithButtons.navToken = NAV_TOKEN,
1498 .navWithButtons.quitButton =
false,
1499 .navWithButtons.backButton =
true,
1500 .navWithButtons.quitText = NULL,
1501 .progressIndicator =
false,
1502 .tuneId = TUNE_TAP_CASUAL};
1505 .topRightIcon = NULL,
1506 .infosList.nbInfos = infos->
nbInfos,
1508 .infosList.infoTypes = infos->
infoTypes,
1511 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1512 .
title = modalTitle,
1513 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1514 .tuneId = TUNE_TAP_CASUAL};
1516 if (modalPageContext != NULL) {
1525static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh)
1528 .nbPages = detailsContext.nbPages,
1530 .quitToken = QUIT_TOKEN,
1531 .navWithButtons.navToken = MODAL_NAV_TOKEN,
1532 .navWithButtons.quitButton =
true,
1533 .navWithButtons.backButton =
true,
1534 .navWithButtons.quitText = NULL,
1535 .progressIndicator =
false,
1536 .tuneId = TUNE_TAP_CASUAL};
1538 .topRightIcon = NULL,
1539 .tagValueList.smallCaseForValue =
true,
1540 .tagValueList.wrapping = detailsContext.wrapping};
1541 uint8_t nbElementsInPage;
1544 if (detailsContext.currentPage <= pageIdx) {
1545 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1549 modalContextGetPageInfo(pageIdx + 1, &nbElementsInPage);
1550 detailsContext.currentPairIdx -= nbElementsInPage;
1551 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1552 detailsContext.currentPairIdx -= nbElementsInPage;
1554 detailsContext.currentPage = pageIdx;
1557 = &genericContext.currentTagValues->pairs[detailsContext.currentPairIdx];
1559 detailsContext.currentPairIdx += nbElementsInPage;
1565 if (modalPageContext != NULL) {
1570 if (forceFullRefresh) {
1579static void displayAddressQRCode(
void)
1583 .withLeftBorder =
true,
1584 .onActionCallback = &modalLayoutTouchCallback,
1585 .tapActionText = NULL};
1587 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1593 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1598 addressConfirmationContext.tagValuePairs[0].value,
1602 if (nbLines <= QRCODE_NB_MAX_LINES) {
1603 qrCode.
text2 = addressConfirmationContext.tagValuePairs[0].value;
1608 addressConfirmationContext.tagValuePairs[0].value,
1610 QRCODE_NB_MAX_LINES,
1612 QRCODE_REDUCED_ADDR_LEN);
1613 qrCode.
text2 = reducedAddress;
1619 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1627static void modalLayoutTouchCallback(
int token, uint8_t index)
1630 if (token == DISMISS_QR_TOKEN) {
1633 addressConfirmationContext.modalLayout = NULL;
1636 else if (token == DISMISS_WARNING_TOKEN) {
1640 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1641 reviewWithWarnCtx.modalLayout = NULL;
1646 reviewWithWarnCtx.securityReportLevel = 1;
1648 if (reviewWithWarnCtx.warning->predefinedSet) {
1649 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1654 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1655 : reviewWithWarnCtx.warning->reviewDetails;
1656 displayCustomizedSecurityReport(details);
1661 else if (token == DISMISS_DETAILS_TOKEN) {
1665 if (choiceWithDetailsCtx.level <= 1) {
1666 choiceWithDetailsCtx.modalLayout = NULL;
1671 choiceWithDetailsCtx.level = 1;
1672 choiceWithDetailsCtx.modalLayout
1673 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1676 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1677 if (sharedContext.usage == SHARE_CTX_REVIEW_WITH_WARNING) {
1680 reviewWithWarnCtx.securityReportLevel = 2;
1682 if (reviewWithWarnCtx.warning->predefinedSet) {
1683 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1688 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1689 : reviewWithWarnCtx.warning->reviewDetails;
1691 displayCustomizedSecurityReport(
1696 else if (sharedContext.usage == SHARE_CTX_CHOICE_WITH_DETAILS) {
1698 = &choiceWithDetailsCtx.details->
barList.
details[token - FIRST_WARN_BAR_TOKEN];
1702 choiceWithDetailsCtx.level = 2;
1703 choiceWithDetailsCtx.modalLayout
1704 = displayModalDetails(details, DISMISS_DETAILS_TOKEN);
1712 genericContext.modalLayout = NULL;
1719static void layoutTouchCallback(
int token, uint8_t index)
1722 if (token == WARNING_CHOICE_TOKEN) {
1724 reviewWithWarnCtx.choiceCallback(
false);
1727 reviewWithWarnCtx.isIntro =
false;
1728 if (reviewWithWarnCtx.isStreaming) {
1729 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1730 reviewWithWarnCtx.icon,
1731 reviewWithWarnCtx.reviewTitle,
1732 reviewWithWarnCtx.reviewSubTitle,
1733 reviewWithWarnCtx.choiceCallback,
1737 useCaseReview(reviewWithWarnCtx.operationType,
1738 reviewWithWarnCtx.tagValueList,
1739 reviewWithWarnCtx.icon,
1740 reviewWithWarnCtx.reviewTitle,
1741 reviewWithWarnCtx.reviewSubTitle,
1742 reviewWithWarnCtx.finishTitle,
1744 reviewWithWarnCtx.choiceCallback,
1751 else if (token == WARNING_BUTTON_TOKEN) {
1753 reviewWithWarnCtx.securityReportLevel = 1;
1755 if (reviewWithWarnCtx.warning->predefinedSet) {
1756 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1761 ? reviewWithWarnCtx.warning->introDetails
1762 : reviewWithWarnCtx.warning->reviewDetails;
1763 displayCustomizedSecurityReport(details);
1767 else if (token == CHOICE_DETAILS_TOKEN) {
1768 choiceWithDetailsCtx.level = 1;
1769 choiceWithDetailsCtx.modalLayout
1770 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1775static void displaySkipWarning(
void)
1778 .cancelText =
"Go back to review",
1779 .centeredInfo.text1 =
"Skip review?",
1781 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1782 .centeredInfo.text3 = NULL,
1784 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1785 .centeredInfo.offsetY = 0,
1786 .confirmationText =
"Yes, skip",
1787 .confirmationToken = SKIP_TOKEN,
1788 .
tuneId = TUNE_TAP_CASUAL,
1790 if (modalPageContext != NULL) {
1802static void updateKeyPad(
bool add)
1804 bool enableValidate, enableBackspace, enableDigits;
1805 bool redrawKeypad =
false;
1808 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1809 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1810 enableBackspace = (keypadContext.pinLen > 0);
1812 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1814 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1816 (keypadContext.pinLen == 1)) {
1817 redrawKeypad =
true;
1821 if ((keypadContext.pinLen == 0) ||
1822 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1824 (keypadContext.pinLen
1825 == (keypadContext.pinMaxDigits - 1))) {
1826 redrawKeypad =
true;
1829 if (keypadContext.hidden ==
true) {
1834 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1838 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1841 if ((!add) && (keypadContext.pinLen == 0)) {
1849static void keypadCallback(
char touchedKey)
1851 switch (touchedKey) {
1853 if (keypadContext.pinLen > 0) {
1854 keypadContext.pinLen--;
1855 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1857 updateKeyPad(
false);
1866 onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1870 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1871 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1872 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1873 keypadContext.pinLen++;
1881static void keypadGeneric_cb(
int token, uint8_t index)
1884 if (token != BACK_TOKEN) {
1905static uint8_t getNbTagValuesInPage(uint8_t nbPairs,
1909 bool hasConfirmationButton,
1910 bool hasDetailsButton,
1911 bool *requireSpecificDisplay)
1913 uint8_t nbPairsInPage = 0;
1914 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
1920 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
1923 *requireSpecificDisplay =
false;
1924 while (nbPairsInPage < nbPairs) {
1931 if (nbPairsInPage > 0) {
1932 currentHeight += INTER_TAG_VALUE_MARGIN;
1935 if (tagValueList->
pairs != NULL) {
1936 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
1939 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
1948 if (nbPairsInPage > 0) {
1955 *requireSpecificDisplay =
true;
1967 value_font = SMALL_REGULAR_FONT;
1970 value_font = LARGE_MEDIUM_FONT;
1979 if (nbPairsInPage == 0) {
1983 *requireSpecificDisplay =
true;
1992 if (hasConfirmationButton && (nbPairsInPage == nbPairs)) {
1993 maxUsableHeight -= UP_FOOTER_BUTTON_HEIGHT;
1994 if (currentHeight > maxUsableHeight) {
1999 else if (hasDetailsButton) {
2000 maxUsableHeight -= (SMALL_BUTTON_RADIUS * 2);
2001 if (currentHeight > maxUsableHeight) {
2005 return nbPairsInPage;
2017static uint8_t getNbTagValuesInDetailsPage(uint8_t nbPairs,
2021 uint8_t nbPairsInPage = 0;
2022 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2025 while (nbPairsInPage < nbPairs) {
2030 if (nbPairsInPage > 0) {
2031 currentHeight += INTER_TAG_VALUE_MARGIN;
2034 if (tagValueList->
pairs != NULL) {
2035 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2038 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2052 if (currentHeight >= maxUsableHeight) {
2057 return nbPairsInPage;
2060static uint8_t getNbPagesForContent(
const nbgl_content_t *content,
2061 uint8_t pageIdxStart,
2065 uint8_t nbElements = 0;
2066 uint8_t nbPages = 0;
2067 uint8_t nbElementsInPage;
2068 uint8_t elemIdx = 0;
2071 nbElements = getContentNbElement(content);
2073 while (nbElements > 0) {
2076 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
2078 nbElementsInPage = getNbTagValuesInPage(nbElements,
2087 nbElementsInPage = getNbTagValuesInPage(nbElements,
2112 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
2115 elemIdx += nbElementsInPage;
2116 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
2117 nbElements -= nbElementsInPage;
2125 uint8_t pageIdxStart,
2128 uint8_t nbPages = 0;
2132 for (
int i = 0; i < genericContents->
nbContents; i++) {
2133 p_content = getContentAtIdx(genericContents, i, &content);
2134 if (p_content == NULL) {
2137 nbPages += getNbPagesForContent(p_content,
2138 pageIdxStart + nbPages,
2146static void prepareAddressConfirmationPages(
const char *address,
2153 addressConfirmationContext.tagValuePairs[0].item =
"Address";
2154 addressConfirmationContext.tagValuePairs[0].value = address;
2155 addressConfirmationContext.nbPairs = 1;
2164 if ((tagValueList != NULL) && (tagValueList->
nbPairs < ADDR_VERIF_NB_PAIRS)) {
2168 for (uint8_t i = 0; i < tagValueList->
nbPairs; i++) {
2169 memcpy(&addressConfirmationContext.tagValuePairs[1 + i],
2170 &tagValueList->
pairs[i],
2172 addressConfirmationContext.nbPairs++;
2176 tmpList.
nbPairs = addressConfirmationContext.nbPairs;
2177 tmpList.
pairs = addressConfirmationContext.tagValuePairs;
2178 addressConfirmationContext.nbPairs = getNbTagValuesInPage(
2179 addressConfirmationContext.nbPairs, &tmpList, 0,
false,
true,
true, &flag);
2181 if (tmpList.
nbPairs > addressConfirmationContext.nbPairs) {
2182 addressConfirmationContext.nbPairs = 1;
2193 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2201 if ((tagValueList != NULL)
2202 && (tagValueList->
nbPairs > (addressConfirmationContext.nbPairs - 1))) {
2212 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2215 = tagValueList->
nbPairs - (addressConfirmationContext.nbPairs - 1);
2217 = &tagValueList->
pairs[addressConfirmationContext.nbPairs - 1];
2226static void bundleNavStartHome(
void)
2228 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2230 useCaseHomeExt(context->appName,
2233 context->settingContents != NULL ?
true : false,
2234 &context->homeAction,
2235 bundleNavStartSettings,
2236 context->quitCallback);
2239static void bundleNavStartSettingsAtPage(uint8_t initSettingPage)
2241 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2245 context->settingContents,
2247 bundleNavStartHome);
2250static void bundleNavStartSettings(
void)
2252 bundleNavStartSettingsAtPage(0);
2255static void bundleNavReviewConfirmRejection(
void)
2257 bundleNavContext.review.choiceCallback(
false);
2264 const char *confirmText;
2269 title =
"Reject transaction?";
2270 confirmText =
"Go back to transaction";
2273 title =
"Reject message?";
2274 confirmText =
"Go back to message";
2277 title =
"Reject operation?";
2278 confirmText =
"Go back to operation";
2285static void bundleNavReviewChoice(
bool confirm)
2288 bundleNavContext.review.choiceCallback(
true);
2291 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
2292 bundleNavReviewConfirmRejection);
2296static void bundleNavReviewStreamingConfirmRejection(
void)
2298 bundleNavContext.reviewStreaming.choiceCallback(
false);
2301static void bundleNavReviewStreamingChoice(
bool confirm)
2308 bundleNavContext.reviewStreaming.choiceCallback(
true);
2311 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
2312 bundleNavReviewStreamingConfirmRejection);
2322 .withLeftBorder =
true,
2323 .onActionCallback = modalLayoutTouchCallback,
2324 .tapActionText = NULL};
2326 .separationLine =
true,
2327 .backAndText.icon = NULL,
2328 .backAndText.tuneId = TUNE_TAP_CASUAL,
2329 .backAndText.token = token};
2345 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2346 bar.
tuneId = TUNE_TAP_CASUAL;
2373static void displaySecurityReport(uint32_t set)
2376 .withLeftBorder =
true,
2377 .onActionCallback = modalLayoutTouchCallback,
2378 .tapActionText = NULL};
2380 .separationLine =
true,
2381 .backAndText.icon = NULL,
2382 .backAndText.tuneId = TUNE_TAP_CASUAL,
2383 .backAndText.token = DISMISS_WARNING_TOKEN};
2387 uint8_t nbWarnings = 0;
2388 const char *provider;
2390 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2403 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
2405 if (reviewWithWarnCtx.warning->predefinedSet & (1 << i)) {
2408 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
2409 bar.
subText = securityReportItems[i].subText;
2412 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
2414 bar.
text = securityReportItems[i].text;
2417 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2418 bar.
tuneId = TUNE_TAP_CASUAL;
2423 bar.
iconLeft = securityReportItems[i].icon;
2434 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2435 provider = reviewWithWarnCtx.warning->reportProvider;
2438 provider =
"[unknown]";
2444 + W3C_DESCRIPTION_MAX_LEN / 2;
2448 .text1 = reviewWithWarnCtx.warning->reportUrl,
2449 .text2 =
"Scan to view full report",
2454 W3C_DESCRIPTION_MAX_LEN / 2,
2456 reviewWithWarnCtx.warning->reportUrl);
2457 urlLen = strlen(destStr) + 1;
2462 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2468 info.
icon = &LARGE_WARNING_ICON;
2469 info.
title =
"This transaction cannot be Clear Signed";
2471 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2472 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2481 info.
icon = &LARGE_WARNING_ICON;
2482 info.
title =
"Transaction Check unavailable";
2484 =
"If you're not using the Ledger Wallet app, Transaction Check might not work. If "
2486 "are using Ledger Wallet, reject the transaction and try again.\n\nGet help at "
2505 reviewWithWarnCtx.modalLayout = displayModalDetails(details, DISMISS_WARNING_TOKEN);
2509static void displayInitialWarning(
void)
2512#ifdef HAVE_PIEZO_SOUND
2513 tune_index_e tune = TUNE_RESERVED;
2517 .token = WARNING_CHOICE_TOKEN,
2518 .topText =
"Back to safety",
2520 .tuneId = TUNE_TAP_CASUAL};
2522 .separationLine =
false,
2523 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2524 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2527 reviewWithWarnCtx.isIntro =
true;
2529 layoutDescription.
modal =
false;
2535 layoutDescription.
ticker.tickerCallback = NULL;
2536 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2539 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2541 reviewWithWarnCtx.layoutCtx,
2543 WARNING_BUTTON_TOKEN,
2546 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2548 reviewWithWarnCtx.warning->introTopRightIcon,
2549 WARNING_BUTTON_TOKEN,
2554 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2557 const char *provider;
2560 info.
icon = &LARGE_WARNING_ICON;
2564 if (reviewWithWarnCtx.warning->reportProvider) {
2565 provider = reviewWithWarnCtx.warning->reportProvider;
2568 provider =
"[unknown]";
2571 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2575 info.
title =
"Blind signing ahead";
2577 =
"This transaction's details are not fully verifiable. If you sign, you could "
2578 "lose all your assets.";
2580#ifdef HAVE_PIEZO_SOUND
2581 tune = TUNE_NEUTRAL;
2585 info.
title =
"Potential risk";
2586 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2590 info.
description = reviewWithWarnCtx.warning->providerMessage;
2592 buttonsInfo.
bottomText =
"Accept risk and continue";
2593#ifdef HAVE_PIEZO_SOUND
2594 tune = TUNE_NEUTRAL;
2598 info.
title =
"Critical threat";
2599 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2603 info.
description = reviewWithWarnCtx.warning->providerMessage;
2605 buttonsInfo.
bottomText =
"Accept threat and continue";
2606#ifdef HAVE_PIEZO_SOUND
2612 else if (reviewWithWarnCtx.warning->info != NULL) {
2615#ifdef HAVE_PIEZO_SOUND
2616 tune = TUNE_LOOK_AT_ME;
2622#ifdef HAVE_PIEZO_SOUND
2623 if (tune != TUNE_RESERVED) {
2624 os_io_seph_cmd_piezo_play_tune(tune);
2634 const char *predefinedTipBoxText = NULL;
2637 if (reviewWithWarnCtx.warning) {
2638 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2640 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2643 predefinedTipBoxText =
"Transaction Check unavailable";
2648 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2651 predefinedTipBoxText =
"Critical threat detected.";
2656 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2659 predefinedTipBoxText =
"Potential risk detected.";
2664 predefinedTipBoxText
2665 =
"No threat detected by Transaction Check but blind signing required.";
2668 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2672 predefinedTipBoxText =
"Blind signing required.";
2676 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2678 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2679 if (predefinedTipBoxText != NULL) {
2680 genericContext.validWarningCtx =
true;
2681 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2682 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2685 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2686 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2688 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2689 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2697 const char *reviewTitle,
2698 const char *reviewSubTitle,
2699 const char *finishTitle,
2703 bool playNotifSound)
2705 bundleNavContext.review.operationType = operationType;
2706 bundleNavContext.review.choiceCallback = choiceCallback;
2709 onChoice = bundleNavReviewChoice;
2710 navType = GENERIC_NAV;
2713 genericContext.genericContents.contentsList = localContentsList;
2714 genericContext.genericContents.nbContents = 3;
2719 prepareReviewFirstPage(
2720 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2723 initWarningTipBox(tipBox);
2727 memcpy(&localContentsList[1].content.tagValueList,
2735 prepareReviewLightLastPage(
2736 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2740 prepareReviewLastPage(
2741 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2745 uint8_t nbPages = getNbPagesForGenericContents(
2747 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2750 if (playNotifSound) {
2751#ifdef HAVE_PIEZO_SOUND
2752 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2756 displayGenericContextPage(0,
true);
2762 const char *reviewTitle,
2763 const char *reviewSubTitle,
2765 bool playNotifSound)
2767 bundleNavContext.reviewStreaming.operationType = operationType;
2768 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2769 bundleNavContext.reviewStreaming.icon = icon;
2772 onChoice = bundleNavReviewStreamingChoice;
2773 navType = STREAMING_NAV;
2776 genericContext.genericContents.contentsList = localContentsList;
2777 genericContext.genericContents.nbContents = 1;
2782 prepareReviewFirstPage(
2783 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2786 initWarningTipBox(NULL);
2789 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2796 if (playNotifSound) {
2797#ifdef HAVE_PIEZO_SOUND
2798 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2802 displayGenericContextPage(0,
true);
2821static void useCaseHomeExt(
const char *appName,
2823 const char *tagline,
2830 .centeredInfo.text1 = appName,
2831 .centeredInfo.text3 = NULL,
2833 .centeredInfo.offsetY = 0,
2836 .tapActionText = NULL,
2838 .topRightToken = CONTINUE_TOKEN,
2839 .tuneId = TUNE_TAP_CASUAL};
2840 reset_callbacks_and_context();
2842 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
2857 if (tagline == NULL) {
2861 "This app enables signing\ntransactions on its network.");
2888 onContinue = topRightCallback;
2889 onQuit = quitCallback;
2903static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
2905 memset(&detailsContext, 0,
sizeof(detailsContext));
2911 detailsContext.tag = tag;
2912 detailsContext.value = value;
2914 detailsContext.currentPage = 0;
2915 detailsContext.wrapping = wrapping;
2917 if (detailsContext.nbPages > 1) {
2918 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
2921 uint8_t nbLinesInLastPage
2927 detailsContext.nbPages++;
2931 displayDetailsPage(0,
true);
2937 uint8_t nbElements = 0;
2938 uint8_t nbElementsInPage;
2939 uint8_t elemIdx = 0;
2942 memset(&detailsContext, 0,
sizeof(detailsContext));
2943 nbElements = tagValues->
nbPairs;
2945 while (nbElements > 0) {
2946 nbElementsInPage = getNbTagValuesInDetailsPage(nbElements, tagValues, elemIdx);
2948 elemIdx += nbElementsInPage;
2949 modalContextSetPageInfo(detailsContext.nbPages, nbElementsInPage);
2950 nbElements -= nbElementsInPage;
2951 detailsContext.nbPages++;
2954 displayTagValueListModalPage(0,
true);
2976 bool *requireSpecificDisplay)
2978 return getNbTagValuesInPage(
2979 nbPairs, tagValueList, startIndex,
false,
false,
false, requireSpecificDisplay);
2999 bool *requireSpecificDisplay)
3001 return getNbTagValuesInPage(
3002 nbPairs, tagValueList, startIndex, isSkippable,
false,
false, requireSpecificDisplay);
3019 uint8_t nbInfosInPage = 0;
3020 uint16_t currentHeight = 0;
3021 uint16_t previousHeight;
3022 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3023 const char *
const *infoContents = PIC(infosList->
infoContents);
3025 while (nbInfosInPage < nbInfos) {
3028 += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING + LIST_ITEM_HEADING_SUB_TEXT;
3032 PIC(infoContents[startIndex + nbInfosInPage]),
3039 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3044 previousHeight = currentHeight;
3047 return nbInfosInPage;
3064 uint8_t nbSwitchesInPage = 0;
3065 uint16_t currentHeight = 0;
3066 uint16_t previousHeight = 0;
3067 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3070 while (nbSwitchesInPage < nbSwitches) {
3074 uint16_t textHeight =
MAX(
3075 LIST_ITEM_MIN_TEXT_HEIGHT,
3077 currentHeight += textHeight + 2 * LIST_ITEM_PRE_HEADING;
3080 currentHeight += LIST_ITEM_HEADING_SUB_TEXT;
3090 previousHeight = currentHeight;
3095 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3098 return nbSwitchesInPage;
3115 uint8_t nbBarsInPage = 0;
3116 uint16_t currentHeight = 0;
3117 uint16_t previousHeight;
3118 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3123 while (nbBarsInPage < nbBars) {
3124 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3129 previousHeight = currentHeight;
3134 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3137 return nbBarsInPage;
3154 uint8_t nbChoicesInPage = 0;
3155 uint16_t currentHeight = 0;
3156 uint16_t previousHeight;
3157 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3159 UNUSED(choicesList);
3162 while (nbChoicesInPage < nbChoices) {
3163 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3168 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3173 previousHeight = currentHeight;
3176 return nbChoicesInPage;
3187 uint8_t nbPages = 0;
3188 uint8_t nbPairs = tagValueList->
nbPairs;
3189 uint8_t nbPairsInPage;
3193 while (i < tagValueList->nbPairs) {
3197 nbPairs -= nbPairsInPage;
3209 const char *tagline,
3216 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3225 const char *tagline,
3227 const char *actionButtonText,
3235 .text = actionButtonText};
3238 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3261 reset_callbacks_and_context();
3264 onQuit = quitCallback;
3265 onNav = navCallback;
3266 onControls = controlsCallback;
3268 navType = SETTINGS_NAV;
3271 prepareNavInfo(
false, nbPages, NULL);
3273 displaySettingsPage(initPage,
true);
3291 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
3312 reset_callbacks_and_context();
3315 onQuit = quitCallback;
3316 pageTitle = appName;
3317 navType = GENERIC_NAV;
3319 if (settingContents != NULL) {
3322 if (infosList != NULL) {
3323 genericContext.hasFinishingContent =
true;
3326 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3330 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3331 if (infosList != NULL) {
3332 nbPages += getNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3335 prepareNavInfo(
false, nbPages, NULL);
3337 displayGenericContextPage(initPage,
true);
3376 const char *appName,
3378 const char *tagline,
3386 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3388 reset_callbacks_and_context();
3390 context->appName = appName;
3391 context->appIcon = appIcon;
3392 context->tagline = tagline;
3393 context->settingContents = settingContents;
3394 context->infosList = infosList;
3395 if (action != NULL) {
3401 context->quitCallback = quitCallback;
3404 bundleNavStartSettingsAtPage(initSettingPage);
3407 bundleNavStartHome();
3421 .tickerIntervale = 0,
3425 reset_callbacks_and_context();
3427 onQuit = quitCallback;
3429#ifdef HAVE_PIEZO_SOUND
3430 os_io_seph_cmd_piezo_play_tune(TUNE_LEDGER_MOMENT);
3433 info.
centeredInfo.
icon = isSuccess ? &CHECK_CIRCLE_ICON : &DENIED_CIRCLE_ICON;
3438 info.
tuneId = TUNE_TAP_CASUAL;
3454 switch (reviewStatusType) {
3456 msg =
"Operation signed";
3460 msg =
"Operation rejected";
3464 msg =
"Transaction signed";
3468 msg =
"Transaction rejected";
3472 msg =
"Message signed";
3476 msg =
"Message rejected";
3480 msg =
"Address verified";
3484 msg =
"Address verification\ncancelled";
3506 const char *message,
3507 const char *subMessage,
3508 const char *confirmText,
3509 const char *cancelText,
3514 if ((confirmText == NULL) || (cancelText == NULL)) {
3517 reset_callbacks_and_context();
3526 info.
tuneId = TUNE_TAP_CASUAL;
3528 onChoice = callback;
3548 const char *message,
3549 const char *subMessage,
3550 const char *confirmText,
3551 const char *cancelText,
3557 .token = CHOICE_TOKEN,
3558 .topText = confirmText,
3560 .tuneId = TUNE_TAP_CASUAL};
3563 .separationLine =
false,
3564 .emptySpace.height = MEDIUM_CENTERING_HEADER};
3567 if ((confirmText == NULL) || (cancelText == NULL)) {
3571 reset_callbacks_and_context();
3573 onChoice = callback;
3574 layoutDescription.
modal =
false;
3580 layoutDescription.
ticker.tickerCallback = NULL;
3581 sharedContext.usage = SHARE_CTX_CHOICE_WITH_DETAILS;
3582 choiceWithDetailsCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
3583 choiceWithDetailsCtx.details = details;
3587 centeredInfo.
icon = icon;
3588 centeredInfo.
title = message;
3592 if (details != NULL) {
3594 choiceWithDetailsCtx.layoutCtx, &SEARCH_ICON, CHOICE_DETAILS_TOKEN, TUNE_TAP_CASUAL);
3615 const char *subMessage,
3616 const char *confirmText,
3617 const char *cancelText,
3623 .centeredInfo.text1 = message,
3624 .centeredInfo.text2 = subMessage,
3625 .centeredInfo.text3 = NULL,
3627 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3628 .centeredInfo.offsetY = 0,
3629 .confirmationText = confirmText,
3630 .confirmationToken = CHOICE_TOKEN,
3631 .tuneId = TUNE_TAP_CASUAL,
3633 onModalConfirm = callback;
3634 if (modalPageContext != NULL) {
3652 const char *message,
3653 const char *actionText,
3658 reset_callbacks_and_context();
3660 onAction = callback;
3662 content.
tuneId = TUNE_TAP_CASUAL;
3685 const char *reviewTitle,
3686 const char *reviewSubTitle,
3687 const char *rejectText,
3692 .footerToken = QUIT_TOKEN,
3693 .tapActionText = NULL,
3694 .isSwipeable =
true,
3695 .tapActionToken = CONTINUE_TOKEN,
3697 .actionButtonText = NULL,
3698 .
tuneId = TUNE_TAP_CASUAL};
3700 reset_callbacks_and_context();
3708 onQuit = rejectCallback;
3709 onContinue = continueCallback;
3711#ifdef HAVE_PIEZO_SOUND
3713 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
3726 const char *rejectText,
3731 reset_callbacks_and_context();
3734 onChoice = choiceCallback;
3735 onNav = navCallback;
3736 onControls = buttonCallback;
3737 forwardNavOnly =
false;
3738 navType = REVIEW_NAV;
3742 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3744 displayReviewPage(initPage,
true);
3761 const char *rejectText,
3766 reset_callbacks_and_context();
3769 onChoice = callback;
3770 navType = GENERIC_NAV;
3774 genericContext.genericContents.contentsList = localContentsList;
3777 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3779 memcpy(&localContentsList[offset].content.tagValueList,
3786 memcpy(&localContentsList[offset].content.infoLongPress,
3792 genericContext.genericContents.nbContents = offset;
3795 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3797 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3799 displayGenericContextPage(0,
true);
3817 const char *rejectText,
3822 reset_callbacks_and_context();
3825 onChoice = callback;
3826 navType = GENERIC_NAV;
3829 genericContext.genericContents.contentsList = localContentsList;
3832 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3834 memcpy(&localContentsList[offset].content.tagValueList,
3848 genericContext.genericContents.nbContents = offset;
3851 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3853 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3855 displayGenericContextPage(0,
true);
3877 const char *reviewTitle,
3878 const char *reviewSubTitle,
3879 const char *finishTitle,
3882 reset_callbacks_and_context();
3884 useCaseReview(operationType,
3918 const char *reviewTitle,
3919 const char *reviewSubTitle,
3920 const char *finishTitle,
3931 &blindSigningWarning,
3960 const char *reviewTitle,
3961 const char *reviewSubTitle,
3962 const char *finishTitle,
3967 reset_callbacks_and_context();
3970 if (tipBox != NULL) {
3971 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
3974 if ((warning == NULL)
3977 useCaseReview(operationType,
3990 operationType |= NO_THREAT_OPERATION;
3993 operationType |= RISKY_OPERATION;
3995 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
3996 reviewWithWarnCtx.isStreaming =
false;
3997 reviewWithWarnCtx.operationType = operationType;
3998 reviewWithWarnCtx.tagValueList = tagValueList;
3999 reviewWithWarnCtx.icon = icon;
4000 reviewWithWarnCtx.reviewTitle = reviewTitle;
4001 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4002 reviewWithWarnCtx.finishTitle = finishTitle;
4003 reviewWithWarnCtx.warning = warning;
4004 reviewWithWarnCtx.choiceCallback = choiceCallback;
4011 useCaseReview(operationType,
4024 displayInitialWarning();
4046 const char *reviewTitle,
4047 const char *reviewSubTitle,
4048 const char *finishTitle,
4051 reset_callbacks_and_context();
4053 useCaseReview(operationType,
4074 const char *rejectText,
4077 reset_callbacks_and_context();
4080 onQuit = rejectCallback;
4081 navType = GENERIC_NAV;
4088 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4089 prepareNavInfo(
true, nbPages, rejectText);
4092#ifdef HAVE_PIEZO_SOUND
4094 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4097 displayGenericContextPage(0,
true);
4114 const char *reviewTitle,
4115 const char *reviewSubTitle,
4118 reset_callbacks_and_context();
4120 useCaseReviewStreamingStart(
4121 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4139 const char *reviewTitle,
4140 const char *reviewSubTitle,
4144 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
4164 const char *reviewTitle,
4165 const char *reviewSubTitle,
4169 reset_callbacks_and_context();
4172 if ((warning == NULL)
4175 useCaseReviewStreamingStart(
4176 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4180 operationType |= NO_THREAT_OPERATION;
4183 operationType |= RISKY_OPERATION;
4186 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4187 reviewWithWarnCtx.isStreaming =
true;
4188 reviewWithWarnCtx.operationType = operationType;
4189 reviewWithWarnCtx.icon = icon;
4190 reviewWithWarnCtx.reviewTitle = reviewTitle;
4191 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4192 reviewWithWarnCtx.choiceCallback = choiceCallback;
4193 reviewWithWarnCtx.warning = warning;
4199 useCaseReviewStreamingStart(
4200 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4203 displayInitialWarning();
4224 memset(&genericContext, 0,
sizeof(genericContext));
4226 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4227 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
4230 onChoice = bundleNavReviewStreamingChoice;
4231 navType = STREAMING_NAV;
4234 genericContext.genericContents.contentsList = localContentsList;
4235 genericContext.genericContents.nbContents = 1;
4244 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4245 &genericContext.genericContents,
4248 prepareNavInfo(
true,
4250 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4258 displayGenericContextPage(0,
true);
4289 memset(&genericContext, 0,
sizeof(genericContext));
4291 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4294 onChoice = bundleNavReviewStreamingChoice;
4295 navType = STREAMING_NAV;
4298 genericContext.genericContents.contentsList = localContentsList;
4299 genericContext.genericContents.nbContents = 1;
4304 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
4305 &STARTING_CONTENT.content.infoLongPress,
4306 bundleNavContext.reviewStreaming.icon,
4310 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4311 &genericContext.genericContents,
4314 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4316 displayGenericContextPage(0,
true);
4327 reset_callbacks_and_context();
4328 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4331 onChoice = callback;
4332 navType = GENERIC_NAV;
4335 genericContext.genericContents.contentsList = localContentsList;
4336 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
4338 prepareAddressConfirmationPages(
4339 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
4342 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4344 prepareNavInfo(
true, nbPages,
"Cancel");
4346#ifdef HAVE_PIEZO_SOUND
4348 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4351 displayGenericContextPage(0,
true);
4373 const char *reviewTitle,
4374 const char *reviewSubTitle,
4377 reset_callbacks_and_context();
4380 if (addressConfirmationContext.modalLayout) {
4383 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4386 onChoice = choiceCallback;
4387 navType = GENERIC_NAV;
4391 genericContext.genericContents.contentsList = localContentsList;
4396 prepareReviewFirstPage(
4397 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4398 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4401 prepareAddressConfirmationPages(
4402 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4405 genericContext.genericContents.nbContents
4407 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4409 prepareNavInfo(
true, nbPages,
"Cancel");
4411#ifdef HAVE_PIEZO_SOUND
4413 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4416 displayGenericContextPage(0,
true);
4430 if (genericContext.type != USE_CASE_SPINNER) {
4431 memset(&genericContext, 0,
sizeof(genericContext));
4432 genericContext.type = USE_CASE_SPINNER;
4437 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4440 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4447 genericContext.spinnerPosition++;
4450 genericContext.spinnerPosition = 0;
4453 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4457 else if (ret == 2) {
4492 .separationLine =
true,
4493 .backAndText.token = BACK_TOKEN,
4494 .backAndText.tuneId = TUNE_TAP_CASUAL,
4495 .backAndText.text = NULL};
4502 reset_callbacks_and_context();
4504 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
4507 onQuit = backCallback;
4511 layoutDescription.
modal =
false;
4514 keypadContext.hidden = hidden;
4526 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
4533 onValidatePin = validatePinCallback;
4535 keypadContext.pinMinDigits = minDigits;
4536 keypadContext.pinMaxDigits = maxDigits;
nbgl_contentTagValue_t *(* nbgl_contentTagValueCallback_t)(uint8_t pairIndex)
prototype of tag/value pair retrieval callback
@ ICON_ILLUSTRATION
simple icon
@ LARGE_CASE_INFO
text in BLACK and large case (INTER 32px), subText in black in Inter24px
@ INFO_LONG_PRESS
a centered info and a long press button
@ EXTENDED_CENTER
a centered content and a possible tip-box
@ CHOICES_LIST
list of choices through radio buttons
@ CENTERED_INFO
a centered info
@ SWITCHES_LIST
list of switches with descriptions
@ TAG_VALUE_DETAILS
a tag/value pair and a small button to get details.
@ INFOS_LIST
list of infos with titles
@ TAG_VALUE_CONFIRM
tag/value pairs and a black button/footer to confirm/cancel.
@ TAG_VALUE_LIST
list of tag/value pairs
@ BARS_LIST
list of touchable bars (with > on the right to go to sub-pages)
@ INFO_BUTTON
a centered info and a simple black button
@ INFO_LIST_ALIAS
alias is list of infos
@ ENS_ALIAS
alias comes from ENS
@ ADDRESS_BOOK_ALIAS
alias comes from Address Book
@ QR_CODE_ALIAS
alias is an address to be displayed as a QR Code
void(* nbgl_contentActionCallback_t)(int token, uint8_t index, int page)
prototype of function to be called when an action on a content object occurs
#define LOG_DEBUG(__logger,...)
bool nbgl_getTextMaxLenInNbLines(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, uint16_t maxNbLines, uint16_t *len, bool wrapping)
compute the len of the given text (in bytes) fitting in the given maximum nb lines,...
void nbgl_textReduceOnNbLines(nbgl_font_id_e fontId, const char *origText, uint16_t maxWidth, uint8_t nbLines, char *reducedText, uint16_t reducedTextLen)
Create a reduced version of given ASCII text to wrap it on the given max width (in pixels),...
uint16_t nbgl_getTextHeightInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
return the height of the given multiline text, with the given font.
uint16_t nbgl_getTextNbLinesInWidth(nbgl_font_id_e fontId, const char *text, uint16_t maxWidth, bool wrapping)
compute the number of lines of the given text fitting in the given maxWidth
void(* nbgl_layoutTouchCallback_t)(int token, uint8_t index)
prototype of function to be called when an object is touched
int nbgl_layoutAddContentCenter(nbgl_layout_t *layout, const nbgl_contentCenter_t *info)
Creates an area on the center of the main panel, with a possible icon, and possible texts under it.
int nbgl_layoutAddTextContent(nbgl_layout_t *layout, const char *title, const char *description, const char *info)
Creates in the main container three text areas:
int nbgl_layoutUpdateKeypad(nbgl_layout_t *layout, uint8_t index, bool enableValidate, bool enableBackspace, bool enableDigits)
Updates an existing keypad on bottom of the screen, with the given configuration.
int nbgl_layoutAddSeparationLine(nbgl_layout_t *layout)
adds a separation line on bottom of the last added item
int nbgl_layoutAddQRCode(nbgl_layout_t *layout, const nbgl_layoutQRCode_t *info)
Creates an area on the center of the main panel, with a QRCode, a possible text in black (bold) under...
int nbgl_layoutDraw(nbgl_layout_t *layout)
Applies given layout. The screen will be redrawn.
int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout)
Creates a touchable bar in main panel.
@ WHITE_BACKGROUND
rounded bordered button, with text/icon in black, on white background
@ BLACK_BACKGROUND
rounded bordered button, with text/icon in white, on black background
int nbgl_layoutAddTopRightButton(nbgl_layout_t *layout, const nbgl_icon_details_t *icon, uint8_t token, tune_index_e tuneId)
Creates a Top-right button in the top right corner of the top panel.
void * nbgl_layout_t
type shared externally
@ HEADER_EMPTY
empty space, to have a better vertical centering of centered info
@ HEADER_BACK_AND_TEXT
back key and optional text
int nbgl_layoutAddKeypadContent(nbgl_layout_t *layout, const char *title, bool hidden, uint8_t nbDigits, const char *text)
Adds an area with a title and a placeholder for hidden digits on top of a keypad, to represent the en...
#define NBGL_INVALID_TOKEN
int nbgl_layoutUpdateKeypadContent(nbgl_layout_t *layout, bool hidden, uint8_t nbActiveDigits, const char *text)
Updates an existing set of hidden digits, with the given configuration.
nbgl_layout_t * nbgl_layoutGet(const nbgl_layoutDescription_t *description)
returns a layout of the given type. The layout is reset
int nbgl_layoutAddExtendedFooter(nbgl_layout_t *layout, const nbgl_layoutFooter_t *footerDesc)
Creates a touchable area at the footer of the screen, containing various controls,...
@ ROUNDED_AND_FOOTER_STYLE
A black background button on top of a footer.
int nbgl_layoutAddChoiceButtons(nbgl_layout_t *layout, const nbgl_layoutChoiceButtons_t *info)
Creates two buttons to make a choice. Both buttons are mandatory. Both buttons are full width,...
int nbgl_layoutAddSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t initPosition)
Creates a centered (vertically & horizontally) spinner with a text under it.
int nbgl_layoutUpdateSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t position)
Update an existing spinner (must be the only object of the layout)
#define NBGL_NO_PROGRESS_INDICATOR
To be used when a control token shall not be used.
int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc)
Creates a touchable (or not) area at the header of the screen, containing various controls,...
@ FOOTER_EMPTY
empty space, to have a better vertical centering of centered info
int nbgl_layoutRelease(nbgl_layout_t *layout)
Release the layout obtained with nbgl_layoutGet()
int nbgl_layoutAddFooter(nbgl_layout_t *layout, const char *text, uint8_t token, tune_index_e tuneId)
Creates a touchable text at the footer of the screen, separated with a thin line from the rest of the...
int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled)
Adds a keypad on bottom of the screen, with the associated callback.
#define NB_SPINNER_POSITIONS
void nbgl_refresh(void)
This functions refreshes the actual screen on display with what has changed since the last refresh.
#define KEYPAD_MAX_DIGITS
void nbgl_refreshSpecial(nbgl_refresh_mode_t mode)
This functions refreshes the actual screen on display with what has changed since the last refresh,...
void nbgl_refreshSpecialWithPostRefresh(nbgl_refresh_mode_t mode, nbgl_post_refresh_t post_refresh)
nbgl_page_t * nbgl_pageDrawGenericContent(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content)
draw a generic content page, with the given content, and if nav parameter is not NULL,...
nbgl_page_t * nbgl_pageDrawInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const nbgl_pageInfoDescription_t *info)
draw a page with a centered info (icon and/or texts) with a touchable footer, in a potential "tapable...
void * nbgl_page_t
type shared externally
@ NAV_WITH_BUTTONS
move forward and backward with buttons in bottom nav bar
nbgl_page_t * nbgl_pageDrawConfirmation(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageConfirmationDescription_t *info)
draw a confirmation page, with a centered info (icon and/or text), a button to confirm and a footer t...
int nbgl_pageRelease(nbgl_page_t *)
Release the page obtained with any of the nbgl_pageDrawXXX() functions.
nbgl_page_t * nbgl_pageDrawGenericContentExt(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content, bool modal)
draw a generic content page, with the given content, and if nav parameter is not NULL,...
@ QUIT_APP_TEXT
A full width button with "Quit app" text (only for bottom button)
@ INFO_ICON
info (i) icon in the button.
@ NO_BUTTON_STYLE
no button.
@ SETTINGS_ICON
settings (wheel) icon in the button.
struct PACKED__ nbgl_screenTickerConfiguration_s nbgl_screenTickerConfiguration_t
struct to configure a screen layer
void nbgl_screenRedraw(void)
This function redraws the whole screen on top of stack and its children.
@ POST_REFRESH_FORCE_POWER_ON
Force screen power on after refresh.
struct PACKED__ nbgl_icon_details_s nbgl_icon_details_t
Represents all information about an icon.
nbgl_refresh_mode_t
different modes of refresh for nbgl_refreshSpecial()
@ FULL_COLOR_CLEAN_REFRESH
to be used for lock screen display (cleaner but longer refresh)
@ BLACK_AND_WHITE_FAST_REFRESH
to be used for pure B&W area, when contrast is not priority
@ FULL_COLOR_PARTIAL_REFRESH
to be used for small partial refresh (radio buttons, switches)
@ FULL_COLOR_REFRESH
to be used for normal refresh
API of the Advanced BOLOS Graphical Library, for typical application use-cases.
DEPRECATED void nbgl_useCaseHome(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
#define NB_MAX_LINES_IN_REVIEW
maximum number of lines for value field in review pages
@ NO_TYPE_WARNING
Invalid type (to use for bars leading to nothing)
@ CENTERED_INFO_WARNING
Centered info.
@ BAR_LIST_WARNING
list of touchable bars, to display sub-pages
DEPRECATED void nbgl_useCaseSettings(const char *settingsTitle, uint8_t initPage, uint8_t nbPages, bool touchableTitle, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
uint8_t nbgl_useCaseGetNbTagValuesInPageExt(uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool isSkippable, bool *requireSpecificDisplay)
void(* nbgl_callback_t)(void)
prototype of generic callback function
#define SKIPPABLE_OPERATION
This is to use in nbgl_operationType_t when the operation is skippable. This is used.
void nbgl_useCaseGenericSettings(const char *appName, uint8_t initPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, nbgl_callback_t quitCallback)
uint32_t nbgl_operationType_t
This mask is used to describe the type of operation to review with additional options It is a mask of...
void nbgl_useCaseReview(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseAction(const nbgl_icon_details_t *icon, const char *message, const char *actionText, nbgl_callback_t callback)
uint8_t nbgl_useCaseGetNbTagValuesInPage(uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool *requireSpecificDisplay)
uint8_t nbgl_useCaseGetNbPagesForTagValueList(const nbgl_contentTagValueList_t *tagValueList)
DEPRECATED void nbgl_useCaseRegularReview(uint8_t initPage, uint8_t nbPages, const char *rejectText, nbgl_layoutTouchCallback_t buttonCallback, nbgl_navCallback_t navCallback, nbgl_choiceCallback_t choiceCallback)
void(* nbgl_pinValidCallback_t)(const uint8_t *pin, uint8_t pinLen)
prototype of pin validation callback function
void nbgl_useCaseReviewStreamingStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseHomeAndSettings(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, const uint8_t initSettingPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, const nbgl_homeAction_t *action, nbgl_callback_t quitCallback)
void nbgl_useCaseStaticReviewLight(const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
uint8_t nbgl_useCaseGetNbInfosInPage(uint8_t nbInfos, const nbgl_contentInfoList_t *infosList, uint8_t startIndex, bool withNav)
void(* nbgl_choiceCallback_t)(bool confirm)
prototype of choice callback function
uint8_t nbgl_useCaseGetNbBarsInPage(uint8_t nbBars, const nbgl_contentBarsList_t *barsList, uint8_t startIndex, bool withNav)
void nbgl_useCaseNavigableContent(const char *title, uint8_t initPage, uint8_t nbPages, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
#define INFOS_AREA_HEIGHT
height available for infos pairs display
@ STRONG_HOME_ACTION
Black button, implicating the main action of the App.
void nbgl_useCaseReviewStreamingFinish(const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseChoiceWithDetails(const nbgl_icon_details_t *icon, const char *message, const char *subMessage, const char *confirmText, const char *cancelText, nbgl_warningDetails_t *details, nbgl_choiceCallback_t callback)
void nbgl_useCaseSpinner(const char *text)
void nbgl_useCaseConfirm(const char *message, const char *subMessage, const char *confirmText, const char *rejectText, nbgl_callback_t callback)
#define NB_MAX_LINES_IN_DETAILS
maximum number of lines for value field in details pages
void nbgl_useCaseReviewStart(const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *rejectText, nbgl_callback_t continueCallback, nbgl_callback_t rejectCallback)
DEPRECATED void nbgl_useCaseHomeExt(const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, const char *actionButtonText, nbgl_callback_t actionCallback, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
#define APP_DESCRIPTION_MAX_LEN
Length of buffer used for the default Home tagline.
void nbgl_useCaseStatus(const char *message, bool isSuccess, nbgl_callback_t quitCallback)
@ W3C_THREAT_DETECTED_WARN
Web3 Checks: Threat detected (see reportRisk field)
@ W3C_ISSUE_WARN
Web3 Checks issue (not available)
@ BLIND_SIGNING_WARN
Blind signing.
@ W3C_NO_THREAT_WARN
Web3 Checks: No Threat detected.
@ W3C_RISK_DETECTED_WARN
Web3 Checks: Risk detected (see reportRisk field)
DEPRECATED void nbgl_useCaseAddressConfirmationExt(const char *address, nbgl_choiceCallback_t callback, const nbgl_contentTagValueList_t *tagValueList)
void nbgl_useCaseGenericConfiguration(const char *title, uint8_t initPage, const nbgl_genericContents_t *contents, nbgl_callback_t quitCallback)
#define INIT_HOME_PAGE
Value to pass to nbgl_useCaseHomeAndSettings() initSettingPage parameter to initialize the use case o...
void nbgl_useCaseKeypad(const char *title, uint8_t minDigits, uint8_t maxDigits, bool shuffled, bool hidden, nbgl_pinValidCallback_t validatePinCallback, nbgl_callback_t backCallback)
void nbgl_useCaseReviewStreamingContinueExt(const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback, nbgl_callback_t skipCallback)
void nbgl_useCaseReviewBlindSigning(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseChoice(const nbgl_icon_details_t *icon, const char *message, const char *subMessage, const char *confirmText, const char *rejectString, nbgl_choiceCallback_t callback)
#define TAG_VALUE_AREA_HEIGHT
height available for tag/value pairs display
#define BLIND_OPERATION
This is to use in nbgl_operationType_t when the operation is "blind" This is used to indicate a warni...
#define TAGLINE_PART1
Default strings used in the Home tagline.
void nbgl_useCaseGenericReview(const nbgl_genericContents_t *contents, const char *rejectText, nbgl_callback_t rejectCallback)
#define STATUS_SCREEN_DURATION
void nbgl_useCaseStaticReview(const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
void nbgl_useCaseReviewStreamingBlindSigningStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseReviewStreamingContinue(const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseReviewLight(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
uint8_t nbgl_useCaseGetNbChoicesInPage(uint8_t nbChoices, const nbgl_contentRadioChoice_t *choicesList, uint8_t startIndex, bool withNav)
#define REAL_TYPE_MASK
This is the mask to apply on nbgl_operationType_t to get the real type provided by app.
void nbgl_useCaseReviewStatus(nbgl_reviewStatusType_t reviewStatusType, nbgl_callback_t quitCallback)
#define LAST_PAGE_FOR_REVIEW
value of page parameter used with navigation callback when "skip" button is touched,...
nbgl_reviewStatusType_t
The different types of review status.
@ STATUS_TYPE_TRANSACTION_REJECTED
@ STATUS_TYPE_ADDRESS_REJECTED
@ STATUS_TYPE_TRANSACTION_SIGNED
@ STATUS_TYPE_OPERATION_REJECTED
@ STATUS_TYPE_OPERATION_SIGNED
@ STATUS_TYPE_ADDRESS_VERIFIED
@ STATUS_TYPE_MESSAGE_SIGNED
@ STATUS_TYPE_MESSAGE_REJECTED
bool(* nbgl_navCallback_t)(uint8_t page, nbgl_pageContent_t *content)
prototype of navigation callback function
#define MAX_APP_NAME_FOR_SDK_TAGLINE
Max supported length of appName used for the default Home tagline.
void nbgl_useCaseAddressReview(const char *address, const nbgl_contentTagValueList_t *additionalTagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
@ TYPE_TRANSACTION
For operations transferring a coin or taken from an account to another.
@ TYPE_OPERATION
For other types of operation (generic type)
void nbgl_useCaseAdvancedReviewStreamingStart(nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
void nbgl_useCaseAdvancedReview(nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
uint8_t nbgl_useCaseGetNbSwitchesInPage(uint8_t nbSwitches, const nbgl_contentSwitchesList_t *switchesList, uint8_t startIndex, bool withNav)
This structure contains data to build a BARS_LIST content.
const uint8_t * tokens
array of tokens, one for each bar (nbBars items)
const char *const * barTexts
array of texts for each bar (nbBars items, in black/bold)
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when a bar is touched
uint8_t nbBars
number of elements in barTexts and tokens array
This structure contains info to build a centered (vertically and horizontally) area,...
uint16_t iconHug
vertical margin to apply on top and bottom of the icon
const nbgl_icon_details_t * icon
the icon (can be null)
const char * title
title in black large (can be null)
const char * description
description in black small regular case (can be null)
const char * subText
sub-text in dark gray regular small case
bool padding
if true, apply a padding of 40px at the bottom
const char * smallTitle
sub-title in black small bold case (can be null)
nbgl_contentIllustrationType_t illustrType
const char * text2
second text (can be null)
const char * text1
first text (can be null)
nbgl_contentCenteredInfoStyle_t style
style to apply to this info
int16_t offsetY
vertical shift to apply to this info (if >0, shift to bottom)
const char * text3
third text (can be null)
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
nbgl_contentCenter_t contentCenter
centered content (icon + text(s))
This structure contains data to build a centered info + simple black button content.
const char * buttonText
text of the long press button
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
const char * text
centered text in large case
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is touched
This structure contains data to build a INFOS_LIST content.
const char *const * infoContents
array of contents of infos (in black)
const char *const * infoTypes
array of types of infos (in black/bold)
const nbgl_contentValueExt_t * infoExtensions
uint8_t nbInfos
number of elements in infoTypes and infoContents array
This structure contains data to build a centered info + long press button content.
const char * longPressText
text of the long press button
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon
const char * text
centered text in large case
This structure contains a list of names to build a list of radio buttons (on the right part of screen...
uint8_t initChoice
index of the current choice
const char *const * names
array of strings giving the choices (nbChoices)
uint8_t nbChoices
number of choices
This structure contains info to build a switch (on the right) with a description (on the left),...
const char * text
main text for the switch
const char * subText
description under main text (NULL terminated, single line, may be null)
This structure contains [item,value] pair(s) and info about a potential "details" button,...
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when details button is touched
const char * confirmationText
text of the confirmation button, if NULL "It matches" is used
uint8_t detailsButtonToken
uint8_t confirmationToken
the token used as argument of the onActionCallback
nbgl_contentTagValueList_t tagValueList
list of tag/value pairs
const char * detailsButtonText
this text is used for "details" button (if NULL, no button)
const nbgl_icon_details_t * detailsButtonIcon
icon to use in details button
const nbgl_icon_details_t * detailsButtonIcon
icon to use in details button
uint8_t detailsButtonToken
const char * detailsButtonText
this text is used for "details" button
nbgl_contentTagValueList_t tagValueList
list of tag/value pairs
This structure contains a list of [tag,value] pairs.
const nbgl_contentTagValue_t * pairs
array of [tag,value] pairs (nbPairs items). If NULL, callback is used instead
nbgl_contentTagValueCallback_t callback
function to call to retrieve a given pair
uint8_t nbMaxLinesForValue
if > 0, set the max number of lines for value field.
bool hideEndOfLastLine
if set to true, replace 3 last chars of last line by "..."
bool wrapping
if set to true, value text will be wrapped on ' ' to avoid cutting words
uint8_t startIndex
index of the first pair to get with callback
nbgl_contentActionCallback_t actionCallback
called when a valueIcon is touched on a given pair
This structure contains a [tag,value] pair and possible extensions.
const nbgl_contentValueExt_t * extension
if not NULL, gives additional info on value field
const nbgl_icon_details_t * valueIcon
int8_t centeredInfo
if set to 1, the tag will be displayed as a centered info
const char * value
string giving the value name
const char * item
string giving the tag name
This structure contains additions to a tag/value pair, to be able to build a screen to display these ...
const char * fullValue
full string of the value when used as an alias
nbgl_contentValueAliasType_t aliasType
type of alias
const struct nbgl_contentTagValueList_s * tagValuelist
if aliasType is TAG_VALUE_LIST_ALIAS
const char * backText
used as title of the popping page, if not NULL, otherwise "item" is used
const struct nbgl_contentInfoList_s * infolist
if aliasType is INFO_LIST_ALIAS
This structure contains data to build a content.
nbgl_contentActionCallback_t contentActionCallback
callback to be called when an action on an object occurs
nbgl_contentType_t type
type of page content in the content union
const struct nbgl_genericDetails_s * details
array of nbBars structures giving what to display when each bar is touched.
uint8_t nbBars
number of touchable bars
const nbgl_icon_details_t ** icons
array of icons for each bar (nbBars items)
const char *const * subTexts
array of texts for each bar (nbBars items, in black)
const char *const * texts
array of texts for each bar (nbBars items, in black/bold)
uint8_t nbContents
number of contents
const nbgl_content_t * contentsList
array of nbgl_content_t (nbContents items).
nbgl_contentCallback_t contentGetterCallback
function to call to retrieve a given content
The necessary parameters to build the page(s) displayed when the top-right button is touched in intro...
const char * title
text of the page (used to go back)
nbgl_genericBarList_t barList
touchable bars list, if type == BAR_LIST_WARNING
nbgl_layoutQRCode_t qrCode
QR code, if type == QRCODE_WARNING.
nbgl_genericDetailsType_t type
type of content in the page, determining what to use in the following union
nbgl_contentCenter_t centeredInfo
centered info, if type == CENTERED_INFO_WARNING
Structure describing the action button in Home Screen.
const nbgl_icon_details_t * icon
icon to use in action button in Home page
nbgl_callback_t callback
function to call when action button is touched in Home page
const char * text
text to use in action button in Home page
nbgl_homeActionStyle_t style
style of action button
This structure contains info to build a clickable "bar" with a text and an icon.
bool inactive
if set to true, the bar is grayed-out and cannot be touched
const char * text
text (can be NULL)
uint8_t token
the token that will be used as argument of the callback
bool large
set to true only for the main level of OS settings
const char * subText
sub text (can be NULL)
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const nbgl_icon_details_t * iconLeft
a buffer containing the 1BPP icon for icon on left (can be NULL)
const nbgl_icon_details_t * iconRight
Structure containing all information when creating a layout. This structure must be passed as argumen...
nbgl_screenTickerConfiguration_t ticker
const char * tapActionText
Light gray text used when main container is "tapable".
nbgl_layoutTouchCallback_t onActionCallback
the callback to be called on any action on the layout
This structure contains info to build a centered (vertically and horizontally) area,...
const char * text2
second text (can be null)
const char * url
URL for QR code.
Structure containing all specific information when creating a confirmation page.
const char * cancelText
the text used for cancel action, if NULL a simple X button is used
uint8_t confirmationToken
the token used as argument of the onActionCallback
const char * confirmationText
text of the confirmation button
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is pressed
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent)
nbgl_contentTagValueDetails_t tagValueDetails
TAG_VALUE_DETAILS type
const char * title
text for the title of the page (if NULL, no title)
uint8_t topRightToken
token used when top-right button (if not NULL) is touched
nbgl_contentInfoLongPress_t infoLongPress
INFO_LONG_PRESS type
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when title is touched
nbgl_contentBarsList_t barsList
BARS_LIST type
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
nbgl_contentInfoList_t infosList
INFOS_LIST type
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
const nbgl_icon_details_t * topRightIcon
nbgl_contentType_t type
type of page content in the following union
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
nbgl_contentTagValueConfirm_t tagValueConfirm
TAG_VALUE_CONFIRM type
bool isTouchableTitle
if set to true, the title is preceded by <- arrow to go back
nbgl_contentExtendedCenter_t extendedCenter
EXTENDED_CENTER type
Structure containing all specific information when creating an information page.
nbgl_layoutButtonStyle_t actionButtonStyle
style of "action" button
const char * actionButtonText
if not NULL an "action" button is set under the centered info
const char * tapActionText
uint8_t bottomButtonsToken
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button/footer is pressed
const nbgl_icon_details_t * actionButtonIcon
potential icon of "action" button
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
Structure containing all specific information when creating a multi-screens page.
uint8_t nbPages
the number of pages to display (if <2, no navigation bar)
uint8_t quitToken
the token used as argument of the actionCallback when the footer is touched
uint8_t skipToken
if skipText is NULL the token used when right part of footer is touched
nbgl_pageNavigationType_t navType
uint8_t activePage
the index of the page to display at start-up
bool progressIndicator
if set to true, display a progress indicator on top of the page
nbgl_pageNavWithButtons_t navWithButtons
structure used when navigation with buttons
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when next or back is pressed
bool visiblePageIndicator
if set to true, the page indicator will be visible in navigation
const char * quitText
the text displayed in footer (on the left), used to quit (only on Flex)
bool backButton
if set to true, a back button (<-) is displayed in the nav bar
This structure contains data to build a SWITCHES_LIST content.
uint8_t nbSwitches
number of elements in switches and tokens array
const nbgl_contentSwitch_t * switches
array of switches (nbSwitches items)
The necessary parameters to build a tip-box in first review page and the modal if this tip box is tou...
const char * text
text of the tip-box
const nbgl_icon_details_t * icon
icon of the tip-box
The necessary parameters to build a warning page preceding a review. One can either use predefinedSet...
const nbgl_warningDetails_t * introDetails
const nbgl_warningDetails_t * reviewDetails
Union of the different type of contents.
nbgl_contentInfoList_t infosList
INFOS_LIST type
nbgl_contentInfoLongPress_t infoLongPress
INFO_LONG_PRESS type
nbgl_contentTagValueConfirm_t tagValueConfirm
TAG_VALUE_CONFIRM type
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
nbgl_contentBarsList_t barsList
BARS_LIST type
nbgl_contentExtendedCenter_t extendedCenter
EXTENDED_CENTER type
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type