WolfSSL
/
wolfTPM
mirror of https://github.com/wolfSSL/wolfTPM.git
1
0
Fork 0
Code Issues Releases Wiki Activity
wolfTPM/examples/gpio/gpio_config.c

266 lines
8.9 KiB
C
Raw Blame History

/* config.c
*
* Copyright (C) 2006-2021 wolfSSL Inc.
*
* This file is part of wolfTPM.
*
* wolfTPM is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* wolfTPM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
/* This examples demonstrates the use of GPIO available on some TPM modules */
#include <wolftpm/tpm2_wrap.h>
#if defined(WOLFTPM_ST33) || defined(WOLFTPM_AUTODETECT)
#include <examples/gpio/gpio.h>
#include <examples/tpm_io.h>
#include <examples/tpm_test.h>
#include <stdio.h>
#include <stdlib.h> /* atoi */
/******************************************************************************/
/* --- BEGIN TPM2.0 GPIO Configuration example -- */
/******************************************************************************/
#define GPIO_MODE_MAX 6
#define GPIO_MODE_UNCONFIG GPIO_MODE_MAX
#define GPIO_MODE_INPUT_MIN 1
#define GPIO_MODE_INPUT_MAX 3
static void usage(void)
{
printf("Expected usage:\n");
printf("./examples/gpio/gpio_config [num] [mode]\n");
printf("* num is a GPIO number between %d-%d (default %d)\n", GPIO_NUM_MIN, GPIO_NUM_MAX, TPM_GPIO_A);
printf("* mode is a number selecting the GPIO mode between 0-%d (default %d):\n", GPIO_MODE_MAX, TPM_GPIO_MODE_PULLDOWN);
printf("\t0. standard - reset to the GPIO's default mode\n");
printf("\t1. floating - input in floating configuration.\n");
printf("\t2. pullup - input with pull up enabled\n");
printf("\t3. pulldown - input with pull down enabled\n");
printf("\t4. opendrain - output in open drain configuration\n");
printf("\t5. pushpull - output in push pull configuration\n");
printf("\t6. unconfigure - delete the NV index for the selected GPIO\n");
printf("Example usage, without parameters, configures GPIO%d as input with a pull down.\n", TPM_GPIO_A);
}
int TPM2_GPIO_Config_Example(void* userCtx, int argc, char *argv[])
{
int rc = -1;
int gpioNum = 0;
WOLFTPM2_DEV dev;
WOLFTPM2_CAPS caps;
WOLFTPM2_NV nv;
WOLFTPM2_HANDLE parent;
TPMI_GPIO_MODE gpioMode = TPM_GPIO_MODE_PULLDOWN;
TPM_HANDLE nvIndex = TPM_NV_GPIO_SPACE;
GpioConfig_In gpio;
SetCommandSet_In setCmdSet;
word32 nvAttributes;
int gpioInput = 1;
BYTE dummy = 0;
if (argc >= 2) {
if (XSTRNCMP(argv[1], "-?", 2) == 0 ||
XSTRNCMP(argv[1], "-h", 2) == 0 ||
XSTRNCMP(argv[1], "--help", 6) == 0) {
usage();
return 0;
}
if (argc == 3) {
gpioMode = atoi(argv[2]);
if (gpioMode > GPIO_MODE_MAX) {
printf("GPIO mode is out of range (0-6)\n");
usage();
goto exit_badargs;
}
/* Check if mode is for GPIO Input to perform extra config step */
if (gpioMode < GPIO_MODE_INPUT_MIN && gpioMode > GPIO_MODE_INPUT_MAX) {
/* GPIO Output mode is chosen, no extra step required */
gpioInput = 0;
}
gpioMode += TPM_GPIO_MODE_STANDARD;
/* Preparing to process next argument */
argc--;
}
if (argc == 2) {
gpioNum = atoi(argv[1]);
if (gpioNum < GPIO_NUM_MIN || gpioNum > GPIO_NUM_MAX) {
printf("GPIO is out of range (%d-%d)\n", GPIO_NUM_MIN, GPIO_NUM_MAX);
usage();
goto exit_badargs;
}
/* Increment NV index used for this GPIO */
nvIndex += gpioNum;
/* Index GPIO name */
gpioNum += TPM_GPIO_A;
/* all arguments processed */
}
}
else if (argc == 1) {
/* Default behavior, without arguments: GPIO 0 as input with a pull down */
gpioMode = TPM_GPIO_MODE_PULLDOWN;
gpioNum = TPM_GPIO_A;
}
else {
printf("Incorrect arguments\n");
usage();
goto exit_badargs;
}
printf("Example for GPIO configuration on a TPM 2.0 module\n");
printf("GPIO number: %d\n", gpioNum);
printf("GPIO mode: %d\n", gpioMode);
/* Sanity check TPM_GPIO_B can be used only as input */
if (gpioNum == TPM_GPIO_B &&
(gpioMode == TPM_GPIO_MODE_PUSHPULL ||
gpioMode == TPM_GPIO_MODE_OPENDRAIN)) {
printf("Warning: TPM_GPIO_B can be used only as an input.\n");
usage();
return 0;
}
rc = wolfTPM2_Init(&dev, TPM2_IoCb, userCtx);
if (rc != TPM_RC_SUCCESS) {
printf("wolfTPM2_Init failed 0x%x: %s\n", rc, TPM2_GetRCString(rc));
goto exit;
}
printf("wolfTPM2_Init: success\n");
/* Get TPM capabilities, to discover the TPM vendor */
rc = wolfTPM2_GetCapabilities(&dev, &caps);
if (rc != TPM_RC_SUCCESS) {
printf("wolfTPM2_GetCapabilities failed 0x%x: %s\n", rc, TPM2_GetRCString(rc));
}
/* Enable TPM2_GPIO_Config command */
if (caps.mfg != TPM_MFG_STM) {
printf("Extra GPIO is supported only on ST33 TPM 2.0 modules\n");
goto exit;
}
#ifdef DEBUG_WOLFTPM
printf("Trying to remove NV index 0x%8.8X used for GPIO\n", nvIndex);
#endif
/* Make sure NV Index for this GPIO is cleared before use
* This way we make sure a new GPIO config can be set
*/
rc = wolfTPM2_NVDelete(&dev, TPM_RH_OWNER, nvIndex);
if (rc == TPM_RC_SUCCESS) {
printf("NV index undefined\n");
}
else if (rc == (TPM_RC_HANDLE | TPM_RC_2)) {
printf("NV Index is available for GPIO use\n");
}
else {
printf("wolfTPM2_NVDelete failed 0x%x: %s\n", rc, TPM2_GetRCString(rc));
}
/* GPIO un-configuration is done using NVDelete, no further action needed */
if (gpioMode == GPIO_MODE_UNCONFIG) {
goto exit;
}
XMEMSET(&setCmdSet, 0, sizeof(setCmdSet));
setCmdSet.authHandle = TPM_RH_PLATFORM;
setCmdSet.commandCode = TPM_CC_GPIO_Config;
setCmdSet.enableFlag = 1;
rc = TPM2_SetCommandSet(&setCmdSet);
if (rc != TPM_RC_SUCCESS) {
printf("TPM2_SetCommandSet failed 0x%x: %s\n", rc, TPM2_GetRCString(rc));
goto exit;
}
/* Configuring a TPM GPIO requires a PLATFORM authorization. Afterwards,
* using that GPIO is up to the user. Therefore, NV Indexes are operated
* using OWNER authorization. See below NVCreateAuth.
*/
XMEMSET(&gpio, 0, sizeof(gpio));
gpio.authHandle = TPM_RH_PLATFORM;
gpio.config.count = 1;
gpio.config.gpio[0].name = gpioNum;
gpio.config.gpio[0].mode = gpioMode;
gpio.config.gpio[0].index = nvIndex;
printf("Trying to configure GPIO%d...\n", gpio.config.gpio[0].name);
rc = TPM2_GPIO_Config(&gpio);
if (rc != TPM_RC_SUCCESS) {
printf("TPM2_GPIO_Config failed 0x%x: %s\n", rc,
TPM2_GetRCString(rc));
goto exit;
}
printf("TPM2_GPIO_Config success\n");
/* Configure NV Index for access to this GPIO */
XMEMSET(&nv, 0, sizeof(nv));
XMEMSET(&parent, 0, sizeof(parent));
/* Prep NV attributes */
parent.hndl = TPM_RH_OWNER;
rc = wolfTPM2_GetNvAttributesTemplate(parent.hndl, &nvAttributes);
if (rc != 0) {
printf("Setting NV attributes failed\n");
goto exit;
}
/* Define NV Index for GPIO */
rc = wolfTPM2_NVCreateAuth(&dev, &parent, &nv, nvIndex, nvAttributes,
sizeof(BYTE), (byte*)gNvAuth, sizeof(gNvAuth)-1);
if (rc != 0) {
printf("Creating NV Index for GPIO acccess failed\n");
goto exit;
}
printf("NV Index for GPIO access created\n");
/* GPIO configured as an input, requires an extra configuration step */
if (gpioInput) {
/* Writing a dummy byte has no impact on the input, but is required */
rc = wolfTPM2_NVWriteAuth(&dev, &nv, nvIndex, &dummy, sizeof(dummy), 0);
if (rc != 0) {
printf("Error while configuring the GPIO as an Input.\n");
}
}
exit:
wolfTPM2_Cleanup(&dev);
exit_badargs:
return rc;
}
/******************************************************************************/
/* --- END TPM2.0 GPIO Configuration example -- */
/******************************************************************************/
#endif /* WOLFTPM_ST33 || WOLFTPM_AUTODETECT */
#ifndef NO_MAIN_DRIVER
int main(int argc, char *argv[])
{
int rc = -1;
#if defined(WOLFTPM_ST33) || defined(WOLFTPM_AUTODETECT)
rc = TPM2_GPIO_Config_Example(NULL, argc, argv);
#else
printf("Extra GPIO is supported only on ST33 TPM 2.0 modules.\n");
(void)argc;
(void)argv;
#endif /* WOLFTPM_ST33 || WOLFTPM_AUTODETECT */
return rc;
}
#endif
Reference in New Issue View Git Blame Copy Permalink