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 keypadContext sharedContext.keypad
57#define reviewWithWarnCtx sharedContext.reviewWithWarning
58#define choiceWithDetailsCtx sharedContext.choiceWithDetails
61#define W3C_DESCRIPTION_MAX_LEN 128
68#define RISKY_OPERATION (1 << 6)
75#define NO_THREAT_OPERATION (1 << 7)
88 ADDRESS_QRCODE_BUTTON_TOKEN,
101 QUIT_TIPBOX_MODAL_TOKEN,
102 WARNING_CHOICE_TOKEN,
104 DISMISS_WARNING_TOKEN,
105 DISMISS_DETAILS_TOKEN,
106 FIRST_WARN_BAR_TOKEN,
117typedef struct DetailsContext_s {
120 uint8_t currentPairIdx;
124 const char *nextPageStart;
127typedef struct AddressConfirmationContext_s {
131} AddressConfirmationContext_t;
134typedef struct KeypadContext_s {
137 uint8_t pinMinDigits;
138 uint8_t pinMaxDigits;
144typedef struct ReviewWithWarningContext_s {
149 const char *reviewTitle;
150 const char *reviewSubTitle;
151 const char *finishTitle;
156 uint8_t securityReportLevel;
158} ReviewWithWarningContext_t;
160typedef struct ChoiceWithDetailsContext_s {
165} ChoiceWithDetailsContext_t;
169 SHARE_CTX_REVIEW_WITH_WARNING,
170 SHARE_CTX_CHOICE_WITH_DETAILS,
171} SharedContextUsage_t;
178 KeypadContext_t keypad;
180 ReviewWithWarningContext_t reviewWithWarning;
181 ChoiceWithDetailsContext_t choiceWithDetails;
183 SharedContextUsage_t usage;
187 USE_CASE_GENERIC = 0,
189} GenericContextType_t;
192 GenericContextType_t type;
193 uint8_t spinnerPosition;
195 int8_t currentContentIdx;
196 uint8_t currentContentElementNb;
197 uint8_t currentElementIdx;
198 bool hasStartingContent;
199 bool hasFinishingContent;
200 const char *detailsItem;
201 const char *detailsvalue;
202 bool detailsWrapping;
203 bool validWarningCtx;
222} nbgl_homeAndSettingsContext_t;
227} nbgl_reviewContext_t;
235} nbgl_reviewStreamingContext_t;
238 nbgl_homeAndSettingsContext_t homeAndSettings;
239 nbgl_reviewContext_t review;
240 nbgl_reviewStreamingContext_t reviewStreaming;
241} nbgl_BundleNavContext_t;
247} SecurityReportItem_t;
254static char tmpString[W3C_DESCRIPTION_MAX_LEN];
274static const char *pageTitle;
281static bool forwardNavOnly;
282static NavType_t navType;
284static DetailsContext_t detailsContext;
287static SharedContext_t sharedContext;
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(
void)
420 onContentAction = NULL;
422 onModalConfirm = NULL;
424 onValidatePin = NULL;
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) {
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) {
683static void pageCallback(
int token, uint8_t index)
686 if (token == QUIT_TOKEN) {
687 if (onQuit != NULL) {
691 else if (token == CONTINUE_TOKEN) {
692 if (onContinue != NULL) {
696 else if (token == CHOICE_TOKEN) {
697 if (onChoice != NULL) {
698 onChoice((index == 0) ?
true : false);
701 else if (token == ACTION_BUTTON_TOKEN) {
702 if ((index == 0) && (onAction != NULL)) {
705 else if ((index == 1) && (onQuit != NULL)) {
710 else if (token == ADDRESS_QRCODE_BUTTON_TOKEN) {
711 displayAddressQRCode();
714 else if (token == CONFIRM_TOKEN) {
715 if (onChoice != NULL) {
719 else if (token == REJECT_TOKEN) {
720 if (onChoice != NULL) {
724 else if (token == DETAILS_BUTTON_TOKEN) {
725 displayDetails(genericContext.detailsItem,
726 genericContext.detailsvalue,
727 genericContext.detailsWrapping);
729 else if (token == NAV_TOKEN) {
731 if (onQuit != NULL) {
736 if (navType == GENERIC_NAV || navType == STREAMING_NAV) {
737 displayGenericContextPage(index,
false);
739 else if (navType == REVIEW_NAV) {
740 displayReviewPage(index,
false);
743 displaySettingsPage(index,
false);
747 else if (token == NEXT_TOKEN) {
749 displayReviewPage(navInfo.
activePage + 1,
false);
752 displayGenericContextPage(navInfo.
activePage + 1,
false);
755 else if (token == BACK_TOKEN) {
757 displayReviewPage(navInfo.
activePage - 1,
true);
760 displayGenericContextPage(navInfo.
activePage - 1,
false);
763 else if (token == SKIP_TOKEN) {
765 displaySkipWarning();
767 else if (token == VALUE_ALIAS_TOKEN) {
770 if (genericContext.currentPairs != NULL) {
771 pair = &genericContext.currentPairs[genericContext.currentElementIdx + index];
774 pair = genericContext.currentCallback(genericContext.currentElementIdx + index);
778 else if (token == BLIND_WARNING_TOKEN) {
779 reviewWithWarnCtx.isIntro =
false;
780 reviewWithWarnCtx.warning = NULL;
783 else if (token == WARNING_BUTTON_TOKEN) {
785 reviewWithWarnCtx.securityReportLevel = 1;
787 if (reviewWithWarnCtx.warning->predefinedSet) {
788 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
792 if (reviewWithWarnCtx.isIntro) {
793 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->introDetails);
796 displayCustomizedSecurityReport(reviewWithWarnCtx.warning->reviewDetails);
800 else if (token == TIP_BOX_TOKEN) {
802 if (genericContext.validWarningCtx && (reviewWithWarnCtx.warning->predefinedSet != 0)) {
803 reviewWithWarnCtx.securityReportLevel = 1;
804 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
807 displayInfosListModal(activeTipBox.
modalTitle, &activeTipBox.
infos,
false);
811 if (onContentAction != NULL) {
812 onContentAction(token, index, navInfo.
activePage);
814 if (onControls != NULL) {
815 onControls(token, index);
821static void tickerCallback(
void)
824 if (onQuit != NULL) {
830static void displaySettingsPage(uint8_t page,
bool forceFullRefresh)
834 if ((onNav == NULL) || (onNav(page, &content) ==
false)) {
839 content.
title = pageTitle;
842 content.
tuneId = TUNE_TAP_CASUAL;
847 if (forceFullRefresh) {
856static void displayReviewPage(uint8_t page,
bool forceFullRefresh)
865 if ((onNav == NULL) || (onNav(navInfo.
activePage, &content) ==
false)) {
870 content.
title = NULL;
872 content.
tuneId = TUNE_TAP_CASUAL;
879 if (forwardNavOnly) {
903 if (forceFullRefresh) {
913static const nbgl_content_t *genericContextComputeNextPageParams(uint8_t pageIdx,
915 uint8_t *p_nbElementsInNextPage,
918 int8_t nextContentIdx = genericContext.currentContentIdx;
919 int16_t nextElementIdx = genericContext.currentElementIdx;
920 uint8_t nbElementsInNextPage;
923 genericContextGetPageInfo(pageIdx, &nbElementsInNextPage, p_flag);
924 *p_nbElementsInNextPage = nbElementsInNextPage;
929 uint8_t nbElementsInCurrentPage;
931 genericContextGetPageInfo(navInfo.
activePage, &nbElementsInCurrentPage, NULL);
932 nextElementIdx += nbElementsInCurrentPage;
937 if ((nextElementIdx >= genericContext.currentContentElementNb)
938 && (genericContext.currentContentElementNb > 0)) {
948 nextElementIdx -= nbElementsInNextPage;
954 if (nextElementIdx < 0) {
956 nextElementIdx = -nbElementsInNextPage;
962 if ((nextContentIdx == -1) && (genericContext.hasStartingContent)) {
963 p_content = &STARTING_CONTENT;
965 else if ((nextContentIdx == genericContext.genericContents.nbContents)
966 && (genericContext.hasFinishingContent)) {
967 p_content = &FINISHING_CONTENT;
970 p_content = getContentAtIdx(&genericContext.genericContents, nextContentIdx, content);
972 if (p_content == NULL) {
987 if ((nextContentIdx != genericContext.currentContentIdx)
988 || (genericContext.currentContentElementNb == 0)) {
989 genericContext.currentContentIdx = nextContentIdx;
990 genericContext.currentContentElementNb = getContentNbElement(p_content);
992 if (nextElementIdx < 0) {
993 nextElementIdx = genericContext.currentContentElementNb + nextElementIdx;
998 if ((nextElementIdx < 0) || (nextElementIdx >= genericContext.currentContentElementNb)) {
1000 "Invalid element index %d / %d\n",
1002 genericContext.currentContentElementNb);
1007 genericContext.currentElementIdx = nextElementIdx;
1015static bool genericContextPreparePageContent(
const nbgl_content_t *p_content,
1016 uint8_t nbElementsInPage,
1020 uint8_t nextElementIdx = genericContext.currentElementIdx;
1022 pageContent->
title = pageTitle;
1025 pageContent->
tuneId = TUNE_TAP_CASUAL;
1027 pageContent->
type = p_content->
type;
1028 switch (pageContent->
type) {
1080 p_tagValueList = NULL;
1092 genericContext.detailsItem = pair->
item;
1093 genericContext.detailsvalue = pair->
value;
1098 if (p_tagValueList != NULL) {
1099 p_tagValueList->
nbPairs = nbElementsInPage;
1102 p_tagValueList->
pairs
1105 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1107 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1113 p_tagValueList->
pairs = NULL;
1117 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1121 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1136 if ((nextElementIdx + nbElementsInPage)
1148 p_tagValueList->
nbPairs = nbElementsInPage;
1149 p_tagValueList->
pairs
1152 for (uint8_t i = 0; i < nbElementsInPage; i++) {
1154 p_tagValueList->
token = VALUE_ALIAS_TOKEN;
1159 genericContext.currentPairs = p_tagValueList->
pairs;
1160 genericContext.currentCallback = p_tagValueList->
callback;
1184 < nextElementIdx + nbElementsInPage)) {
1204 bool isFirstOrLastPage
1208 = (navType == STREAMING_NAV)
1209 ? bundleNavContext.reviewStreaming.operationType
1210 : ((navType == GENERIC_NAV) ? bundleNavContext.review.operationType : 0);
1213 if (isFirstOrLastPage
1214 && (operationType & (
BLIND_OPERATION | RISKY_OPERATION | NO_THREAT_OPERATION))) {
1216 if ((operationType & NO_THREAT_OPERATION)
1225 = (operationType &
BLIND_OPERATION) ? BLIND_WARNING_TOKEN : WARNING_BUTTON_TOKEN;
1232static void displayGenericContextPage(uint8_t pageIdx,
bool forceFullRefresh)
1236 uint8_t nbElementsInPage;
1240 if (navType == STREAMING_NAV) {
1242 if (bundleNavContext.reviewStreaming.skipCallback != NULL) {
1243 bundleNavContext.reviewStreaming.skipCallback();
1247 else if (pageIdx >= bundleNavContext.reviewStreaming.stepPageNb) {
1248 bundleNavReviewStreamingChoice(
true);
1255 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1260 for (
int i = navInfo.
activePage + 1; i <= pageIdx; i++) {
1261 p_content = genericContextComputeNextPageParams(i, &content, &nbElementsInPage, &flag);
1271 = genericContextComputeNextPageParams(pageIdx, &content, &nbElementsInPage, &flag);
1274 if (p_content == NULL) {
1280 if (!genericContextPreparePageContent(p_content, nbElementsInPage, flag, &pageContent)) {
1286 if (forceFullRefresh) {
1295static const char *getDetailsPageAt(uint8_t detailsPage)
1298 const char *currentChar = detailsContext.value;
1299 while (page < detailsPage) {
1309 detailsContext.wrapping);
1311 currentChar = currentChar + len;
1319static void displayDetailsPage(uint8_t detailsPage,
bool forceFullRefresh)
1323 .nbPages = detailsContext.nbPages,
1325 .quitToken = QUIT_TOKEN,
1326 .navWithButtons.navToken = NAV_TOKEN,
1327 .navWithButtons.quitButton =
true,
1328 .navWithButtons.backButton =
true,
1329 .navWithButtons.quitText = NULL,
1330 .progressIndicator =
false,
1331 .tuneId = TUNE_TAP_CASUAL};
1333 .topRightIcon = NULL,
1334 .tagValueList.nbPairs = 1,
1335 .tagValueList.pairs = ¤tPair,
1336 .tagValueList.smallCaseForValue =
true,
1337 .tagValueList.wrapping = detailsContext.wrapping};
1339 if (modalPageContext != NULL) {
1342 currentPair.
item = detailsContext.tag;
1344 if (detailsPage <= detailsContext.currentPage) {
1346 currentPair.
value = getDetailsPageAt(detailsPage);
1347 forceFullRefresh =
true;
1351 currentPair.
value = detailsContext.nextPageStart;
1353 detailsContext.currentPage = detailsPage;
1364 detailsContext.wrapping);
1367 detailsContext.nextPageStart = currentPair.
value + len;
1373 detailsContext.nextPageStart = NULL;
1382 if (forceFullRefresh) {
1391static void displayFullValuePage(
const char *backText,
1392 const char *aliasText,
1395 const char *modalTitle
1396 = (extension->
backText != NULL) ? PIC(extension->
backText) : PIC(backText);
1398 genericContext.currentInfos = extension->
infolist;
1399 displayInfosListModal(modalTitle, extension->
infolist,
true);
1402 genericContext.currentTagValues = extension->
tagValuelist;
1407 .withLeftBorder =
true,
1408 .onActionCallback = &modalLayoutTouchCallback,
1409 .tapActionText = NULL};
1411 .separationLine =
false,
1412 .backAndText.token = 0,
1413 .backAndText.tuneId = TUNE_TAP_CASUAL,
1414 .backAndText.text = modalTitle};
1423 .text1 = (extension->
title != NULL) ? extension->
title : extension->fullValue,
1424 .text2 = extension->explanation,
1435 info =
"ENS names are resolved by Ledger backend.";
1438 info =
"This account label comes from your Address Book in Ledger Live.";
1444 genericContext.modalLayout, aliasText, extension->
fullValue, info);
1453static void displayInfosListModal(
const char *modalTitle,
1460 .quitToken = QUIT_TIPBOX_MODAL_TOKEN,
1461 .navWithButtons.navToken = NAV_TOKEN,
1462 .navWithButtons.quitButton =
false,
1463 .navWithButtons.backButton =
true,
1464 .navWithButtons.quitText = NULL,
1465 .progressIndicator =
false,
1466 .tuneId = TUNE_TAP_CASUAL};
1469 .topRightIcon = NULL,
1470 .infosList.nbInfos = infos->
nbInfos,
1472 .infosList.infoTypes = infos->
infoTypes,
1475 .infosList.token = fromReview ? INFO_ALIAS_TOKEN : INFOS_TIP_BOX_TOKEN,
1476 .
title = modalTitle,
1477 .titleToken = QUIT_TIPBOX_MODAL_TOKEN,
1478 .tuneId = TUNE_TAP_CASUAL};
1480 if (modalPageContext != NULL) {
1489static void displayTagValueListModalPage(uint8_t pageIdx,
bool forceFullRefresh)
1492 .nbPages = detailsContext.nbPages,
1494 .quitToken = QUIT_TOKEN,
1495 .navWithButtons.navToken = MODAL_NAV_TOKEN,
1496 .navWithButtons.quitButton =
true,
1497 .navWithButtons.backButton =
true,
1498 .navWithButtons.quitText = NULL,
1499 .progressIndicator =
false,
1500 .tuneId = TUNE_TAP_CASUAL};
1502 .topRightIcon = NULL,
1503 .tagValueList.smallCaseForValue =
true,
1504 .tagValueList.wrapping = detailsContext.wrapping};
1505 uint8_t nbElementsInPage;
1508 if (detailsContext.currentPage <= pageIdx) {
1509 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1513 modalContextGetPageInfo(pageIdx + 1, &nbElementsInPage);
1514 detailsContext.currentPairIdx -= nbElementsInPage;
1515 modalContextGetPageInfo(pageIdx, &nbElementsInPage);
1516 detailsContext.currentPairIdx -= nbElementsInPage;
1518 detailsContext.currentPage = pageIdx;
1521 = &genericContext.currentTagValues->pairs[detailsContext.currentPairIdx];
1523 detailsContext.currentPairIdx += nbElementsInPage;
1529 if (modalPageContext != NULL) {
1534 if (forceFullRefresh) {
1543static void displayAddressQRCode(
void)
1547 .withLeftBorder =
true,
1548 .onActionCallback = &modalLayoutTouchCallback,
1549 .tapActionText = NULL};
1551 .
type =
HEADER_EMPTY, .separationLine =
false, .emptySpace.height = SMALL_CENTERING_HEADER};
1557 addressConfirmationContext.modalLayout =
nbgl_layoutGet(&layoutDescription);
1562 addressConfirmationContext.tagValuePairs[0].value,
1566 if (nbLines <= QRCODE_NB_MAX_LINES) {
1567 qrCode.
text2 = addressConfirmationContext.tagValuePairs[0].value;
1572 addressConfirmationContext.tagValuePairs[0].value,
1574 QRCODE_NB_MAX_LINES,
1576 QRCODE_REDUCED_ADDR_LEN);
1577 qrCode.
text2 = reducedAddress;
1583 addressConfirmationContext.modalLayout,
"Close", DISMISS_QR_TOKEN, TUNE_TAP_CASUAL);
1591static void modalLayoutTouchCallback(
int token, uint8_t index)
1594 if (token == DISMISS_QR_TOKEN) {
1597 addressConfirmationContext.modalLayout = NULL;
1600 else if (token == DISMISS_WARNING_TOKEN) {
1604 if (reviewWithWarnCtx.securityReportLevel <= 1) {
1605 reviewWithWarnCtx.modalLayout = NULL;
1610 reviewWithWarnCtx.securityReportLevel = 1;
1612 if (reviewWithWarnCtx.warning->predefinedSet) {
1613 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1618 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1619 : reviewWithWarnCtx.warning->reviewDetails;
1620 displayCustomizedSecurityReport(details);
1625 else if (token == DISMISS_DETAILS_TOKEN) {
1629 if (choiceWithDetailsCtx.level <= 1) {
1630 choiceWithDetailsCtx.modalLayout = NULL;
1635 choiceWithDetailsCtx.level = 1;
1636 choiceWithDetailsCtx.modalLayout
1637 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1640 else if ((token >= FIRST_WARN_BAR_TOKEN) && (token <= LAST_WARN_BAR_TOKEN)) {
1641 if (sharedContext.usage == SHARE_CTX_REVIEW_WITH_WARNING) {
1644 reviewWithWarnCtx.securityReportLevel = 2;
1646 if (reviewWithWarnCtx.warning->predefinedSet) {
1647 displaySecurityReport(1 << (token - FIRST_WARN_BAR_TOKEN));
1652 = (reviewWithWarnCtx.isIntro) ? reviewWithWarnCtx.warning->introDetails
1653 : reviewWithWarnCtx.warning->reviewDetails;
1655 displayCustomizedSecurityReport(
1660 else if (sharedContext.usage == SHARE_CTX_CHOICE_WITH_DETAILS) {
1662 = &choiceWithDetailsCtx.details->
barList.
details[token - FIRST_WARN_BAR_TOKEN];
1666 choiceWithDetailsCtx.level = 2;
1667 choiceWithDetailsCtx.modalLayout
1668 = displayModalDetails(details, DISMISS_DETAILS_TOKEN);
1676 genericContext.modalLayout = NULL;
1683static void layoutTouchCallback(
int token, uint8_t index)
1686 if (token == WARNING_CHOICE_TOKEN) {
1688 reviewWithWarnCtx.choiceCallback(
false);
1691 reviewWithWarnCtx.isIntro =
false;
1692 if (reviewWithWarnCtx.isStreaming) {
1693 useCaseReviewStreamingStart(reviewWithWarnCtx.operationType,
1694 reviewWithWarnCtx.icon,
1695 reviewWithWarnCtx.reviewTitle,
1696 reviewWithWarnCtx.reviewSubTitle,
1697 reviewWithWarnCtx.choiceCallback,
1701 useCaseReview(reviewWithWarnCtx.operationType,
1702 reviewWithWarnCtx.tagValueList,
1703 reviewWithWarnCtx.icon,
1704 reviewWithWarnCtx.reviewTitle,
1705 reviewWithWarnCtx.reviewSubTitle,
1706 reviewWithWarnCtx.finishTitle,
1708 reviewWithWarnCtx.choiceCallback,
1715 else if (token == WARNING_BUTTON_TOKEN) {
1717 reviewWithWarnCtx.securityReportLevel = 1;
1719 if (reviewWithWarnCtx.warning->predefinedSet) {
1720 displaySecurityReport(reviewWithWarnCtx.warning->predefinedSet);
1725 ? reviewWithWarnCtx.warning->introDetails
1726 : reviewWithWarnCtx.warning->reviewDetails;
1727 displayCustomizedSecurityReport(details);
1731 else if (token == CHOICE_DETAILS_TOKEN) {
1732 choiceWithDetailsCtx.level = 1;
1733 choiceWithDetailsCtx.modalLayout
1734 = displayModalDetails(choiceWithDetailsCtx.details, DISMISS_DETAILS_TOKEN);
1739static void displaySkipWarning(
void)
1742 .cancelText =
"Go back to review",
1743 .centeredInfo.text1 =
"Skip review?",
1745 =
"If you're sure you don't need to review all fields, you can skip straight to signing.",
1746 .centeredInfo.text3 = NULL,
1748 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
1749 .centeredInfo.offsetY = 0,
1750 .confirmationText =
"Yes, skip",
1751 .confirmationToken = SKIP_TOKEN,
1752 .
tuneId = TUNE_TAP_CASUAL,
1754 if (modalPageContext != NULL) {
1766static void updateKeyPad(
bool add)
1768 bool enableValidate, enableBackspace, enableDigits;
1769 bool redrawKeypad =
false;
1772 enableDigits = (keypadContext.pinLen < keypadContext.pinMaxDigits);
1773 enableValidate = (keypadContext.pinLen >= keypadContext.pinMinDigits);
1774 enableBackspace = (keypadContext.pinLen > 0);
1776 if ((keypadContext.pinLen == keypadContext.pinMinDigits)
1778 (keypadContext.pinLen == keypadContext.pinMaxDigits)
1780 (keypadContext.pinLen == 1)) {
1781 redrawKeypad =
true;
1785 if ((keypadContext.pinLen == 0) ||
1786 (keypadContext.pinLen == (keypadContext.pinMinDigits - 1))
1788 (keypadContext.pinLen
1789 == (keypadContext.pinMaxDigits - 1))) {
1790 redrawKeypad =
true;
1793 if (keypadContext.hidden ==
true) {
1798 keypadContext.layoutCtx,
false, 0, (
const char *) keypadContext.pinEntry);
1802 keypadContext.layoutCtx, 0, enableValidate, enableBackspace, enableDigits);
1805 if ((!add) && (keypadContext.pinLen == 0)) {
1813static void keypadCallback(
char touchedKey)
1815 switch (touchedKey) {
1817 if (keypadContext.pinLen > 0) {
1818 keypadContext.pinLen--;
1819 keypadContext.pinEntry[keypadContext.pinLen] = 0;
1821 updateKeyPad(
false);
1830 onValidatePin(keypadContext.pinEntry, keypadContext.pinLen);
1834 if ((touchedKey >= 0x30) && (touchedKey < 0x40)) {
1835 if (keypadContext.pinLen < keypadContext.pinMaxDigits) {
1836 keypadContext.pinEntry[keypadContext.pinLen] = touchedKey;
1837 keypadContext.pinLen++;
1846static void keypadGenericUseCase(
const char *title,
1852 tune_index_e tuneId,
1858 .separationLine =
true,
1859 .backAndText.token = backToken,
1860 .backAndText.tuneId = tuneId,
1861 .backAndText.text = NULL};
1870 memset(&keypadContext, 0,
sizeof(KeypadContext_t));
1874 layoutDescription.
modal =
false;
1877 keypadContext.hidden = hidden;
1889 keypadContext.layoutCtx, title, keypadContext.hidden, maxDigits,
"");
1896 onValidatePin = validatePinCallback;
1898 keypadContext.pinMinDigits = minDigits;
1899 keypadContext.pinMaxDigits = maxDigits;
1920static uint8_t getNbTagValuesInPage(uint8_t nbPairs,
1924 bool hasConfirmationButton,
1925 bool hasDetailsButton,
1926 bool *requireSpecificDisplay)
1928 uint8_t nbPairsInPage = 0;
1929 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
1935 maxUsableHeight -= TOUCHABLE_HEADER_BAR_HEIGHT - SMALL_CENTERING_HEADER;
1938 *requireSpecificDisplay =
false;
1939 while (nbPairsInPage < nbPairs) {
1946 if (nbPairsInPage > 0) {
1947 currentHeight += INTER_TAG_VALUE_MARGIN;
1950 if (tagValueList->
pairs != NULL) {
1951 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
1954 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
1963 if (nbPairsInPage > 0) {
1970 *requireSpecificDisplay =
true;
1982 value_font = SMALL_REGULAR_FONT;
1985 value_font = LARGE_MEDIUM_FONT;
1994 if (nbPairsInPage == 0) {
1998 *requireSpecificDisplay =
true;
2007 if (hasConfirmationButton && (nbPairsInPage == nbPairs)) {
2008 maxUsableHeight -= UP_FOOTER_BUTTON_HEIGHT;
2009 if (currentHeight > maxUsableHeight) {
2014 else if (hasDetailsButton) {
2015 maxUsableHeight -= (SMALL_BUTTON_RADIUS * 2);
2016 if (currentHeight > maxUsableHeight) {
2020 return nbPairsInPage;
2032static uint8_t getNbTagValuesInDetailsPage(uint8_t nbPairs,
2036 uint8_t nbPairsInPage = 0;
2037 uint16_t currentHeight = PRE_TAG_VALUE_MARGIN;
2040 while (nbPairsInPage < nbPairs) {
2045 if (nbPairsInPage > 0) {
2046 currentHeight += INTER_TAG_VALUE_MARGIN;
2049 if (tagValueList->
pairs != NULL) {
2050 pair = PIC(&tagValueList->
pairs[startIndex + nbPairsInPage]);
2053 pair = PIC(tagValueList->
callback(startIndex + nbPairsInPage));
2067 if (currentHeight >= maxUsableHeight) {
2072 return nbPairsInPage;
2075static uint8_t getNbPagesForContent(
const nbgl_content_t *content,
2076 uint8_t pageIdxStart,
2080 uint8_t nbElements = 0;
2081 uint8_t nbPages = 0;
2082 uint8_t nbElementsInPage;
2083 uint8_t elemIdx = 0;
2086 nbElements = getContentNbElement(content);
2088 while (nbElements > 0) {
2091 bool hasNav = !isLast || (pageIdxStart > 0) || (elemIdx > 0);
2093 nbElementsInPage = getNbTagValuesInPage(nbElements,
2102 nbElementsInPage = getNbTagValuesInPage(nbElements,
2127 nbElementsInPage =
MIN(nbMaxElementsPerContentType[content->
type], nbElements);
2130 elemIdx += nbElementsInPage;
2131 genericContextSetPageInfo(pageIdxStart + nbPages, nbElementsInPage, flag);
2132 nbElements -= nbElementsInPage;
2140 uint8_t pageIdxStart,
2143 uint8_t nbPages = 0;
2147 for (
int i = 0; i < genericContents->
nbContents; i++) {
2148 p_content = getContentAtIdx(genericContents, i, &content);
2149 if (p_content == NULL) {
2152 nbPages += getNbPagesForContent(p_content,
2153 pageIdxStart + nbPages,
2161static void prepareAddressConfirmationPages(
const char *address,
2168 addressConfirmationContext.tagValuePairs[0].item =
"Address";
2169 addressConfirmationContext.tagValuePairs[0].value = address;
2170 addressConfirmationContext.nbPairs = 1;
2179 if ((tagValueList != NULL) && (tagValueList->
nbPairs < ADDR_VERIF_NB_PAIRS)) {
2183 for (uint8_t i = 0; i < tagValueList->
nbPairs; i++) {
2184 memcpy(&addressConfirmationContext.tagValuePairs[1 + i],
2185 &tagValueList->
pairs[i],
2187 addressConfirmationContext.nbPairs++;
2191 tmpList.
nbPairs = addressConfirmationContext.nbPairs;
2192 tmpList.
pairs = addressConfirmationContext.tagValuePairs;
2193 addressConfirmationContext.nbPairs = getNbTagValuesInPage(
2194 addressConfirmationContext.nbPairs, &tmpList, 0,
false,
true,
true, &flag);
2196 if (tmpList.
nbPairs > addressConfirmationContext.nbPairs) {
2197 addressConfirmationContext.nbPairs = 1;
2208 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2216 if ((tagValueList != NULL)
2217 && (tagValueList->
nbPairs > (addressConfirmationContext.nbPairs - 1))) {
2227 tagValueConfirm->
tuneId = TUNE_TAP_CASUAL;
2230 = tagValueList->
nbPairs - (addressConfirmationContext.nbPairs - 1);
2232 = &tagValueList->
pairs[addressConfirmationContext.nbPairs - 1];
2241static void bundleNavStartHome(
void)
2243 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2245 useCaseHomeExt(context->appName,
2248 context->settingContents != NULL ?
true : false,
2249 &context->homeAction,
2250 bundleNavStartSettings,
2251 context->quitCallback);
2254static void bundleNavStartSettingsAtPage(uint8_t initSettingPage)
2256 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
2260 context->settingContents,
2262 bundleNavStartHome);
2265static void bundleNavStartSettings(
void)
2267 bundleNavStartSettingsAtPage(0);
2270static void bundleNavReviewConfirmRejection(
void)
2272 bundleNavContext.review.choiceCallback(
false);
2279 const char *confirmText;
2284 title =
"Reject transaction?";
2285 confirmText =
"Go back to transaction";
2288 title =
"Reject message?";
2289 confirmText =
"Go back to message";
2292 title =
"Reject operation?";
2293 confirmText =
"Go back to operation";
2300static void bundleNavReviewChoice(
bool confirm)
2303 bundleNavContext.review.choiceCallback(
true);
2306 bundleNavReviewAskRejectionConfirmation(bundleNavContext.review.operationType,
2307 bundleNavReviewConfirmRejection);
2311static void bundleNavReviewStreamingConfirmRejection(
void)
2313 bundleNavContext.reviewStreaming.choiceCallback(
false);
2316static void bundleNavReviewStreamingChoice(
bool confirm)
2323 bundleNavContext.reviewStreaming.choiceCallback(
true);
2326 bundleNavReviewAskRejectionConfirmation(bundleNavContext.reviewStreaming.operationType,
2327 bundleNavReviewStreamingConfirmRejection);
2337 .withLeftBorder =
true,
2338 .onActionCallback = modalLayoutTouchCallback,
2339 .tapActionText = NULL};
2341 .separationLine =
true,
2342 .backAndText.icon = NULL,
2343 .backAndText.tuneId = TUNE_TAP_CASUAL,
2344 .backAndText.token = token};
2360 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2361 bar.
tuneId = TUNE_TAP_CASUAL;
2388static void displaySecurityReport(uint32_t set)
2391 .withLeftBorder =
true,
2392 .onActionCallback = modalLayoutTouchCallback,
2393 .tapActionText = NULL};
2395 .separationLine =
true,
2396 .backAndText.icon = NULL,
2397 .backAndText.tuneId = TUNE_TAP_CASUAL,
2398 .backAndText.token = DISMISS_WARNING_TOKEN};
2402 uint8_t nbWarnings = 0;
2403 const char *provider;
2405 reviewWithWarnCtx.modalLayout =
nbgl_layoutGet(&layoutDescription);
2418 if ((reviewWithWarnCtx.securityReportLevel == 1) && (!reviewWithWarnCtx.isIntro)) {
2420 if (reviewWithWarnCtx.warning->predefinedSet & (1 << i)) {
2423 || (reviewWithWarnCtx.warning->providerMessage == NULL)) {
2424 bar.
subText = securityReportItems[i].subText;
2427 bar.
subText = reviewWithWarnCtx.warning->providerMessage;
2429 bar.
text = securityReportItems[i].text;
2432 bar.
token = FIRST_WARN_BAR_TOKEN + i;
2433 bar.
tuneId = TUNE_TAP_CASUAL;
2438 bar.
iconLeft = securityReportItems[i].icon;
2449 if (reviewWithWarnCtx.warning && reviewWithWarnCtx.warning->reportProvider) {
2450 provider = reviewWithWarnCtx.warning->reportProvider;
2453 provider =
"[unknown]";
2459 + W3C_DESCRIPTION_MAX_LEN / 2;
2463 .text1 = reviewWithWarnCtx.warning->reportUrl,
2464 .text2 =
"Scan to view full report",
2469 W3C_DESCRIPTION_MAX_LEN / 2,
2471 reviewWithWarnCtx.warning->reportUrl);
2472 urlLen = strlen(destStr) + 1;
2477 snprintf(destStr + urlLen, W3C_DESCRIPTION_MAX_LEN / 2 - urlLen,
"%s report", provider);
2483 info.
icon = &LARGE_WARNING_ICON;
2484 info.
title =
"This transaction cannot be Clear Signed";
2486 =
"This transaction or message cannot be decoded fully. If you choose to sign, you "
2487 "could be authorizing malicious actions that can drain your wallet.\n\nLearn more: "
2496 info.
icon = &LARGE_WARNING_ICON;
2497 info.
title =
"Transaction Check unavailable";
2499 =
"If you're not using the\nLedger Live app, Transaction Check might not work. If your "
2500 "are using Ledger Live, reject the transaction and try again.\n\nGet help at "
2519 reviewWithWarnCtx.modalLayout = displayModalDetails(details, DISMISS_WARNING_TOKEN);
2523static void displayInitialWarning(
void)
2526#ifdef HAVE_PIEZO_SOUND
2527 tune_index_e tune = TUNE_RESERVED;
2531 .token = WARNING_CHOICE_TOKEN,
2532 .topText =
"Back to safety",
2534 .tuneId = TUNE_TAP_CASUAL};
2536 .separationLine =
false,
2537 .emptySpace.height = MEDIUM_CENTERING_HEADER};
2538 uint32_t set = reviewWithWarnCtx.warning->predefinedSet
2541 reviewWithWarnCtx.isIntro =
true;
2543 layoutDescription.
modal =
false;
2549 layoutDescription.
ticker.tickerCallback = NULL;
2550 reviewWithWarnCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
2553 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2555 reviewWithWarnCtx.layoutCtx,
2557 WARNING_BUTTON_TOKEN,
2560 else if (reviewWithWarnCtx.warning->introTopRightIcon != NULL) {
2562 reviewWithWarnCtx.warning->introTopRightIcon,
2563 WARNING_BUTTON_TOKEN,
2568 if (reviewWithWarnCtx.warning->predefinedSet != 0) {
2571 const char *provider;
2574 info.
icon = &LARGE_WARNING_ICON;
2578 if (reviewWithWarnCtx.warning->reportProvider) {
2579 provider = reviewWithWarnCtx.warning->reportProvider;
2582 provider =
"[unknown]";
2585 snprintf(tmpString, W3C_DESCRIPTION_MAX_LEN,
"Detected by %s", provider);
2589 info.
title =
"Blind signing ahead";
2591 =
"This transaction's details are not fully verifiable. If you sign, you could "
2592 "lose all your assets.";
2594#ifdef HAVE_PIEZO_SOUND
2595 tune = TUNE_NEUTRAL;
2599 info.
title =
"Potential risk";
2600 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2604 info.
description = reviewWithWarnCtx.warning->providerMessage;
2606 buttonsInfo.
bottomText =
"Accept risk and continue";
2607#ifdef HAVE_PIEZO_SOUND
2608 tune = TUNE_NEUTRAL;
2612 info.
title =
"Critical threat";
2613 if (reviewWithWarnCtx.warning->providerMessage == NULL) {
2617 info.
description = reviewWithWarnCtx.warning->providerMessage;
2619 buttonsInfo.
bottomText =
"Accept threat and continue";
2620#ifdef HAVE_PIEZO_SOUND
2626 else if (reviewWithWarnCtx.warning->info != NULL) {
2629#ifdef HAVE_PIEZO_SOUND
2630 tune = TUNE_LOOK_AT_ME;
2636#ifdef HAVE_PIEZO_SOUND
2637 if (tune != TUNE_RESERVED) {
2638 os_io_seph_cmd_piezo_play_tune(tune);
2648 const char *predefinedTipBoxText = NULL;
2651 if (reviewWithWarnCtx.warning) {
2652 if (reviewWithWarnCtx.warning->predefinedSet & (1 <<
W3C_ISSUE_WARN)) {
2654 predefinedTipBoxText =
"Transaction Check unavailable.\nBlind signing required.";
2657 predefinedTipBoxText =
"Transaction Check unavailable";
2662 predefinedTipBoxText =
"Critical threat detected.\nBlind signing required.";
2665 predefinedTipBoxText =
"Critical threat detected.";
2670 predefinedTipBoxText =
"Potential risk detected.\nBlind signing required.";
2673 predefinedTipBoxText =
"Potential risk detected.";
2678 predefinedTipBoxText
2679 =
"No threat detected by Transaction Check but blind signing required.";
2682 predefinedTipBoxText =
"No threat detected by Transaction Check.";
2686 predefinedTipBoxText =
"Blind signing required.";
2690 if ((tipBox != NULL) || (predefinedTipBoxText != NULL)) {
2692 STARTING_CONTENT.content.extendedCenter.contentCenter.subText = NULL;
2693 if (predefinedTipBoxText != NULL) {
2694 genericContext.validWarningCtx =
true;
2695 STARTING_CONTENT.content.extendedCenter.tipBox.icon = NULL;
2696 STARTING_CONTENT.content.extendedCenter.tipBox.text = predefinedTipBoxText;
2699 STARTING_CONTENT.content.extendedCenter.tipBox.icon = tipBox->
icon;
2700 STARTING_CONTENT.content.extendedCenter.tipBox.text = tipBox->
text;
2702 STARTING_CONTENT.content.extendedCenter.tipBox.token = TIP_BOX_TOKEN;
2703 STARTING_CONTENT.content.extendedCenter.tipBox.tuneId = TUNE_TAP_CASUAL;
2711 const char *reviewTitle,
2712 const char *reviewSubTitle,
2713 const char *finishTitle,
2717 bool playNotifSound)
2720 memset(&genericContext, 0,
sizeof(genericContext));
2722 bundleNavContext.review.operationType = operationType;
2723 bundleNavContext.review.choiceCallback = choiceCallback;
2726 onChoice = bundleNavReviewChoice;
2727 navType = GENERIC_NAV;
2730 genericContext.genericContents.contentsList = localContentsList;
2731 genericContext.genericContents.nbContents = 3;
2736 prepareReviewFirstPage(
2737 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2740 initWarningTipBox(tipBox);
2744 memcpy(&localContentsList[1].content.tagValueList,
2752 prepareReviewLightLastPage(
2753 operationType, &localContentsList[2].content.infoButton, icon, finishTitle);
2757 prepareReviewLastPage(
2758 operationType, &localContentsList[2].content.infoLongPress, icon, finishTitle);
2762 uint8_t nbPages = getNbPagesForGenericContents(
2764 prepareNavInfo(
true, nbPages, getRejectReviewText(operationType));
2767 if (playNotifSound) {
2768#ifdef HAVE_PIEZO_SOUND
2769 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2773 displayGenericContextPage(0,
true);
2779 const char *reviewTitle,
2780 const char *reviewSubTitle,
2782 bool playNotifSound)
2785 memset(&genericContext, 0,
sizeof(genericContext));
2787 bundleNavContext.reviewStreaming.operationType = operationType;
2788 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
2789 bundleNavContext.reviewStreaming.icon = icon;
2792 onChoice = bundleNavReviewStreamingChoice;
2793 navType = STREAMING_NAV;
2796 genericContext.genericContents.contentsList = localContentsList;
2797 genericContext.genericContents.nbContents = 1;
2802 prepareReviewFirstPage(
2803 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
2806 initWarningTipBox(NULL);
2809 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
2816 if (playNotifSound) {
2817#ifdef HAVE_PIEZO_SOUND
2818 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
2822 displayGenericContextPage(0,
true);
2841static void useCaseHomeExt(
const char *appName,
2843 const char *tagline,
2852 .centeredInfo.text1 = appName,
2853 .centeredInfo.text3 = NULL,
2855 .centeredInfo.offsetY = 0,
2858 .tapActionText = NULL,
2860 .topRightToken = CONTINUE_TOKEN,
2861 .tuneId = TUNE_TAP_CASUAL};
2862 if ((homeAction->
text != NULL) || (homeAction->
icon != NULL)) {
2877 if (tagline == NULL) {
2881 "This app enables signing\ntransactions on its network.");
2908 onContinue = topRightCallback;
2909 onQuit = quitCallback;
2923static void displayDetails(
const char *tag,
const char *value,
bool wrapping)
2925 memset(&detailsContext, 0,
sizeof(detailsContext));
2931 detailsContext.tag = tag;
2932 detailsContext.value = value;
2934 detailsContext.currentPage = 0;
2935 detailsContext.wrapping = wrapping;
2937 if (detailsContext.nbPages > 1) {
2938 uint16_t nbLostChars = (detailsContext.nbPages - 1) * 3;
2941 uint8_t nbLinesInLastPage
2947 detailsContext.nbPages++;
2951 displayDetailsPage(0,
true);
2957 uint8_t nbElements = 0;
2958 uint8_t nbElementsInPage;
2959 uint8_t elemIdx = 0;
2962 memset(&detailsContext, 0,
sizeof(detailsContext));
2963 nbElements = tagValues->
nbPairs;
2965 while (nbElements > 0) {
2966 nbElementsInPage = getNbTagValuesInDetailsPage(nbElements, tagValues, elemIdx);
2968 elemIdx += nbElementsInPage;
2969 modalContextSetPageInfo(detailsContext.nbPages, nbElementsInPage);
2970 nbElements -= nbElementsInPage;
2971 detailsContext.nbPages++;
2974 displayTagValueListModalPage(0,
true);
2996 bool *requireSpecificDisplay)
2998 return getNbTagValuesInPage(
2999 nbPairs, tagValueList, startIndex,
false,
false,
false, requireSpecificDisplay);
3019 bool *requireSpecificDisplay)
3021 return getNbTagValuesInPage(
3022 nbPairs, tagValueList, startIndex, isSkippable,
false,
false, requireSpecificDisplay);
3039 uint8_t nbInfosInPage = 0;
3040 uint16_t currentHeight = 0;
3041 uint16_t previousHeight;
3042 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3043 const char *
const *infoContents = PIC(infosList->
infoContents);
3045 while (nbInfosInPage < nbInfos) {
3048 += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING + LIST_ITEM_HEADING_SUB_TEXT;
3052 PIC(infoContents[startIndex + nbInfosInPage]),
3059 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3064 previousHeight = currentHeight;
3067 return nbInfosInPage;
3084 uint8_t nbSwitchesInPage = 0;
3085 uint16_t currentHeight = 0;
3086 uint16_t previousHeight = 0;
3087 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3090 while (nbSwitchesInPage < nbSwitches) {
3094 uint16_t textHeight =
MAX(
3095 LIST_ITEM_MIN_TEXT_HEIGHT,
3097 currentHeight += textHeight + 2 * LIST_ITEM_PRE_HEADING;
3100 currentHeight += LIST_ITEM_HEADING_SUB_TEXT;
3110 previousHeight = currentHeight;
3115 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3118 return nbSwitchesInPage;
3135 uint8_t nbBarsInPage = 0;
3136 uint16_t currentHeight = 0;
3137 uint16_t previousHeight;
3138 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3143 while (nbBarsInPage < nbBars) {
3144 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3149 previousHeight = currentHeight;
3154 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3157 return nbBarsInPage;
3174 uint8_t nbChoicesInPage = 0;
3175 uint16_t currentHeight = 0;
3176 uint16_t previousHeight;
3177 uint16_t navHeight = withNav ? SIMPLE_FOOTER_HEIGHT : 0;
3179 UNUSED(choicesList);
3182 while (nbChoicesInPage < nbChoices) {
3183 currentHeight += LIST_ITEM_MIN_TEXT_HEIGHT + 2 * LIST_ITEM_PRE_HEADING;
3188 if (!withNav && (previousHeight >= (
INFOS_AREA_HEIGHT - SIMPLE_FOOTER_HEIGHT))) {
3193 previousHeight = currentHeight;
3196 return nbChoicesInPage;
3207 uint8_t nbPages = 0;
3208 uint8_t nbPairs = tagValueList->
nbPairs;
3209 uint8_t nbPairsInPage;
3213 while (i < tagValueList->nbPairs) {
3217 nbPairs -= nbPairsInPage;
3229 const char *tagline,
3236 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3245 const char *tagline,
3247 const char *actionButtonText,
3255 .text = actionButtonText};
3258 appName, appIcon, tagline, withSettings, &homeAction, topRightCallback, quitCallback);
3284 onQuit = quitCallback;
3285 onNav = navCallback;
3286 onControls = controlsCallback;
3288 navType = SETTINGS_NAV;
3291 prepareNavInfo(
false, nbPages, NULL);
3293 displaySettingsPage(initPage,
true);
3311 title, initPage, nbPages, quitCallback, navCallback, controlsCallback);
3333 memset(&genericContext, 0,
sizeof(genericContext));
3336 onQuit = quitCallback;
3337 pageTitle = appName;
3338 navType = GENERIC_NAV;
3340 if (settingContents != NULL) {
3343 if (infosList != NULL) {
3344 genericContext.hasFinishingContent =
true;
3347 memcpy(&FINISHING_CONTENT.content, infosList,
sizeof(
nbgl_content_u));
3351 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3352 if (infosList != NULL) {
3353 nbPages += getNbPagesForContent(&FINISHING_CONTENT, nbPages,
true,
false);
3356 prepareNavInfo(
false, nbPages, NULL);
3358 displayGenericContextPage(initPage,
true);
3397 const char *appName,
3399 const char *tagline,
3407 nbgl_homeAndSettingsContext_t *context = &bundleNavContext.homeAndSettings;
3409 context->appName = appName;
3410 context->appIcon = appIcon;
3411 context->tagline = tagline;
3412 context->settingContents = settingContents;
3413 context->infosList = infosList;
3414 if (action != NULL) {
3420 context->quitCallback = quitCallback;
3423 bundleNavStartSettingsAtPage(initSettingPage);
3426 bundleNavStartHome();
3442 .tickerIntervale = 0,
3445 onQuit = quitCallback;
3447#ifdef HAVE_PIEZO_SOUND
3448 os_io_seph_cmd_piezo_play_tune(TUNE_LEDGER_MOMENT);
3456 .centeredInfo.icon = &DENIED_CIRCLE_ICON,
3457 .centeredInfo.offsetY = SMALL_FOOTER_HEIGHT / 2,
3458 .centeredInfo.onTop =
false,
3460 .centeredInfo.text1 = message,
3461 .centeredInfo.text2 = NULL,
3462 .centeredInfo.text3 = NULL,
3463 .tapActionText =
"",
3464 .isSwipeable =
false,
3465 .tapActionToken = QUIT_TOKEN,
3467 .actionButtonText = NULL,
3468 .tuneId = TUNE_TAP_CASUAL};
3485 switch (reviewStatusType) {
3487 msg =
"Operation signed";
3491 msg =
"Operation rejected";
3495 msg =
"Transaction signed";
3499 msg =
"Transaction rejected";
3503 msg =
"Message signed";
3507 msg =
"Message rejected";
3511 msg =
"Address verified";
3515 msg =
"Address verification\ncancelled";
3537 const char *message,
3538 const char *subMessage,
3539 const char *confirmText,
3540 const char *cancelText,
3547 .centeredInfo.text2 = subMessage,
3548 .centeredInfo.text3 = NULL,
3550 .centeredInfo.icon = icon,
3551 .centeredInfo.offsetY = 0,
3552 .confirmationText = confirmText,
3553 .confirmationToken = CHOICE_TOKEN,
3554 .tuneId = TUNE_TAP_CASUAL,
3557 if ((confirmText == NULL) || (cancelText == NULL)) {
3560 onChoice = callback;
3580 const char *message,
3581 const char *subMessage,
3582 const char *confirmText,
3583 const char *cancelText,
3590 .token = CHOICE_TOKEN,
3591 .topText = confirmText,
3593 .tuneId = TUNE_TAP_CASUAL};
3596 .separationLine =
false,
3597 .emptySpace.height = MEDIUM_CENTERING_HEADER};
3600 if ((confirmText == NULL) || (cancelText == NULL)) {
3603 onChoice = callback;
3604 layoutDescription.
modal =
false;
3610 layoutDescription.
ticker.tickerCallback = NULL;
3611 sharedContext.usage = SHARE_CTX_CHOICE_WITH_DETAILS;
3612 choiceWithDetailsCtx.layoutCtx =
nbgl_layoutGet(&layoutDescription);
3613 choiceWithDetailsCtx.details = details;
3617 centeredInfo.
icon = icon;
3618 centeredInfo.
title = message;
3622 if (details != NULL) {
3624 choiceWithDetailsCtx.layoutCtx, &SEARCH_ICON, CHOICE_DETAILS_TOKEN, TUNE_TAP_CASUAL);
3645 const char *subMessage,
3646 const char *confirmText,
3647 const char *cancelText,
3653 .centeredInfo.text1 = message,
3654 .centeredInfo.text2 = subMessage,
3655 .centeredInfo.text3 = NULL,
3657 .centeredInfo.icon = &IMPORTANT_CIRCLE_ICON,
3658 .centeredInfo.offsetY = 0,
3659 .confirmationText = confirmText,
3660 .confirmationToken = CHOICE_TOKEN,
3661 .tuneId = TUNE_TAP_CASUAL,
3663 onModalConfirm = callback;
3664 if (modalPageContext != NULL) {
3682 const char *message,
3683 const char *actionText,
3689 onAction = callback;
3691 content.
tuneId = TUNE_TAP_CASUAL;
3714 const char *reviewTitle,
3715 const char *reviewSubTitle,
3716 const char *rejectText,
3723 .footerToken = QUIT_TOKEN,
3724 .tapActionText = NULL,
3725 .isSwipeable =
true,
3726 .tapActionToken = CONTINUE_TOKEN,
3728 .actionButtonText = NULL,
3729 .
tuneId = TUNE_TAP_CASUAL};
3736 onQuit = rejectCallback;
3737 onContinue = continueCallback;
3739#ifdef HAVE_PIEZO_SOUND
3741 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
3754 const char *rejectText,
3762 onChoice = choiceCallback;
3763 onNav = navCallback;
3764 onControls = buttonCallback;
3765 forwardNavOnly =
false;
3766 navType = REVIEW_NAV;
3770 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3772 displayReviewPage(initPage,
true);
3789 const char *rejectText,
3795 memset(&genericContext, 0,
sizeof(genericContext));
3798 onChoice = callback;
3799 navType = GENERIC_NAV;
3803 genericContext.genericContents.contentsList = localContentsList;
3806 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3808 memcpy(&localContentsList[offset].content.tagValueList,
3815 memcpy(&localContentsList[offset].content.infoLongPress,
3821 genericContext.genericContents.nbContents = offset;
3824 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3826 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3828 displayGenericContextPage(0,
true);
3846 const char *rejectText,
3852 memset(&genericContext, 0,
sizeof(genericContext));
3855 onChoice = callback;
3856 navType = GENERIC_NAV;
3859 genericContext.genericContents.contentsList = localContentsList;
3862 if (tagValueList != NULL && tagValueList->
nbPairs != 0) {
3864 memcpy(&localContentsList[offset].content.tagValueList,
3878 genericContext.genericContents.nbContents = offset;
3881 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
3883 prepareNavInfo(
true, nbPages, getRejectReviewText(
TYPE_OPERATION));
3885 displayGenericContextPage(0,
true);
3907 const char *reviewTitle,
3908 const char *reviewSubTitle,
3909 const char *finishTitle,
3912 useCaseReview(operationType,
3946 const char *reviewTitle,
3947 const char *reviewSubTitle,
3948 const char *finishTitle,
3959 &blindSigningWarning,
3988 const char *reviewTitle,
3989 const char *reviewSubTitle,
3990 const char *finishTitle,
3995 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
3997 if (tipBox != NULL) {
3998 memcpy(&activeTipBox, tipBox,
sizeof(activeTipBox));
4001 memset(&activeTipBox, 0,
sizeof(activeTipBox));
4004 if ((warning == NULL)
4007 useCaseReview(operationType,
4020 operationType |= NO_THREAT_OPERATION;
4023 operationType |= RISKY_OPERATION;
4025 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4026 reviewWithWarnCtx.isStreaming =
false;
4027 reviewWithWarnCtx.operationType = operationType;
4028 reviewWithWarnCtx.tagValueList = tagValueList;
4029 reviewWithWarnCtx.icon = icon;
4030 reviewWithWarnCtx.reviewTitle = reviewTitle;
4031 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4032 reviewWithWarnCtx.finishTitle = finishTitle;
4033 reviewWithWarnCtx.warning = warning;
4034 reviewWithWarnCtx.choiceCallback = choiceCallback;
4041 useCaseReview(operationType,
4054 displayInitialWarning();
4076 const char *reviewTitle,
4077 const char *reviewSubTitle,
4078 const char *finishTitle,
4081 useCaseReview(operationType,
4102 const char *rejectText,
4106 memset(&genericContext, 0,
sizeof(genericContext));
4109 onQuit = rejectCallback;
4110 navType = GENERIC_NAV;
4117 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4118 prepareNavInfo(
true, nbPages, rejectText);
4121#ifdef HAVE_PIEZO_SOUND
4123 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4126 displayGenericContextPage(0,
true);
4143 const char *reviewTitle,
4144 const char *reviewSubTitle,
4147 useCaseReviewStreamingStart(
4148 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4166 const char *reviewTitle,
4167 const char *reviewSubTitle,
4171 operationType, icon, reviewTitle, reviewSubTitle, &blindSigningWarning, choiceCallback);
4191 const char *reviewTitle,
4192 const char *reviewSubTitle,
4196 memset(&reviewWithWarnCtx, 0,
sizeof(reviewWithWarnCtx));
4198 if ((warning == NULL)
4201 useCaseReviewStreamingStart(
4202 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4206 operationType |= NO_THREAT_OPERATION;
4209 operationType |= RISKY_OPERATION;
4212 sharedContext.usage = SHARE_CTX_REVIEW_WITH_WARNING;
4213 reviewWithWarnCtx.isStreaming =
true;
4214 reviewWithWarnCtx.operationType = operationType;
4215 reviewWithWarnCtx.icon = icon;
4216 reviewWithWarnCtx.reviewTitle = reviewTitle;
4217 reviewWithWarnCtx.reviewSubTitle = reviewSubTitle;
4218 reviewWithWarnCtx.choiceCallback = choiceCallback;
4219 reviewWithWarnCtx.warning = warning;
4225 useCaseReviewStreamingStart(
4226 operationType, icon, reviewTitle, reviewSubTitle, choiceCallback,
true);
4229 displayInitialWarning();
4250 memset(&genericContext, 0,
sizeof(genericContext));
4252 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4253 bundleNavContext.reviewStreaming.skipCallback = skipCallback;
4256 onChoice = bundleNavReviewStreamingChoice;
4257 navType = STREAMING_NAV;
4260 genericContext.genericContents.contentsList = localContentsList;
4261 genericContext.genericContents.nbContents = 1;
4270 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4271 &genericContext.genericContents,
4274 prepareNavInfo(
true,
4276 getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4284 displayGenericContextPage(0,
true);
4315 memset(&genericContext, 0,
sizeof(genericContext));
4317 bundleNavContext.reviewStreaming.choiceCallback = choiceCallback;
4320 onChoice = bundleNavReviewStreamingChoice;
4321 navType = STREAMING_NAV;
4324 genericContext.genericContents.contentsList = localContentsList;
4325 genericContext.genericContents.nbContents = 1;
4330 prepareReviewLastPage(bundleNavContext.reviewStreaming.operationType,
4331 &STARTING_CONTENT.content.infoLongPress,
4332 bundleNavContext.reviewStreaming.icon,
4336 bundleNavContext.reviewStreaming.stepPageNb = getNbPagesForGenericContents(
4337 &genericContext.genericContents,
4340 prepareNavInfo(
true, 1, getRejectReviewText(bundleNavContext.reviewStreaming.operationType));
4342 displayGenericContextPage(0,
true);
4354 memset(&genericContext, 0,
sizeof(genericContext));
4355 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4358 onChoice = callback;
4359 navType = GENERIC_NAV;
4362 genericContext.genericContents.contentsList = localContentsList;
4363 genericContext.genericContents.nbContents = (tagValueList == NULL) ? 1 : 2;
4365 prepareAddressConfirmationPages(
4366 address, tagValueList, &STARTING_CONTENT, &localContentsList[1]);
4369 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4371 prepareNavInfo(
true, nbPages,
"Cancel");
4373#ifdef HAVE_PIEZO_SOUND
4375 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4378 displayGenericContextPage(0,
true);
4400 const char *reviewTitle,
4401 const char *reviewSubTitle,
4405 memset(&genericContext, 0,
sizeof(genericContext));
4407 if (addressConfirmationContext.modalLayout) {
4410 memset(&addressConfirmationContext, 0,
sizeof(addressConfirmationContext));
4413 onChoice = choiceCallback;
4414 navType = GENERIC_NAV;
4418 genericContext.genericContents.contentsList = localContentsList;
4423 prepareReviewFirstPage(
4424 &STARTING_CONTENT.content.extendedCenter.contentCenter, icon, reviewTitle, reviewSubTitle);
4425 STARTING_CONTENT.content.extendedCenter.contentCenter.subText =
"Swipe to continue";
4428 prepareAddressConfirmationPages(
4429 address, additionalTagValueList, &localContentsList[1], &localContentsList[2]);
4432 genericContext.genericContents.nbContents
4434 uint8_t nbPages = getNbPagesForGenericContents(&genericContext.genericContents, 0,
false);
4436 prepareNavInfo(
true, nbPages,
"Cancel");
4438#ifdef HAVE_PIEZO_SOUND
4440 os_io_seph_cmd_piezo_play_tune(TUNE_LOOK_AT_ME);
4443 displayGenericContextPage(0,
true);
4457 if (genericContext.type != USE_CASE_SPINNER) {
4458 memset(&genericContext, 0,
sizeof(genericContext));
4459 genericContext.type = USE_CASE_SPINNER;
4464 genericContext.backgroundLayout =
nbgl_layoutGet(&layoutDescription);
4467 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4474 genericContext.spinnerPosition++;
4477 genericContext.spinnerPosition = 0;
4480 genericContext.backgroundLayout, text, NULL, genericContext.spinnerPosition);
4484 else if (ret == 2) {
4515 tune_index_e tuneId,
4519 keypadGenericUseCase(title,
4526 validatePinCallback,
4553 tune_index_e tuneId,
4557 keypadGenericUseCase(title,
4564 validatePinCallback,
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_pageDrawLedgerInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const char *text, int tapActionToken)
draw a page with a centered text in large case, with a round check icon
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)
void nbgl_useCaseKeypadPIN(const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)
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)
void nbgl_useCaseKeypadDigits(const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)
#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_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
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
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
uint8_t bottomButtonsToken
const nbgl_icon_details_t * actionButtonIcon
potential icon of "action" button
nbgl_pageButtonStyle_t bottomButtonStyle
style to apply to the Bottom 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 * modalTitle
title given to modal window displayed when tip-box is touched
nbgl_contentInfoList_t infos
infos pairs displayed in modal, if type is INFOS_LIST.
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