hw_accelerator_driver_ipecc_platform.c

/*
 *  Copyright (C) 2023 - This file is part of IPECC project
 *
 *  Authors:
 *      Karim KHALFALLAH <karim.khalfallah@ssi.gouv.fr>
 *      Ryad BENADJILA <ryadbenadjila@gmail.com>
 *
 *  Contributors:
 *      Adrian THILLARD
 *      Emmanuel PROUFF
 *
 *  This software is licensed under GPL v2 license.
 *  See LICENSE file at the root folder of the project.
 */

#include "hw_accelerator_driver_ipecc_platform.h"

#include <stdint.h>

#include "ecc_platform.h"

#if defined(WITH_EC_HW_ACCELERATOR) && !defined(WITH_EC_HW_SOCKET_EMUL)

/* The IP "physical" address in RAM.
 *
 * This address should only be used for direct access in standalone
 * mode or using a physical memory access (e.g. through /dev/mem).
 *
 * #Defining IPECC_PHYS_BADDR is always preceeded with a '#ifndef' test
 * so as to allow you to set it through gcc '-D' inline setting instead.
 *
 * As for the 'pseudo TRNG' feature, yt's under construction and will
 * probably never actually be implemented, so please just ignore it.
 */
#ifdef WITH_EC_HW_STANDALONE_XILINX
  #include <xparameters.h>
  #ifndef IPECC_PHYS_BADDR
    #define IPECC_PHYS_BADDR                (XPAR_ECC_0_BASEADDR)
  #endif
  #ifdef XPAR_PSEUDO_TRNG_0_BASEADDR
    #define IPECC_PHYS_PSEUDO_TRNG_BADDR    (XPAR_PSEUDO_TRNG_0_BASEADDR)
  #else
    #define IPECC_PHYS_PSEUDO_TRNG_BADDR    (NULL)
  #endif
#else
  #ifdef IPECC_PLATFORM_ULTRASCALE
    #ifndef IPECC_PHYS_BADDR
      #define IPECC_PHYS_BADDR                0x80000000
    #endif
    #define IPECC_PHYS_PSEUDO_TRNG_BADDR    0x80001000
  #else
    #ifdef IPECC_PLATFORM_SERIES7
      #ifndef IPECC_PHYS_BADDR
        #define IPECC_PHYS_BADDR                0x40000000
      #endif
      #define IPECC_PHYS_PSEUDO_TRNG_BADDR    0x40001000
    #else
      #error "hw_accelerator_driver_ipecc_platform.c: could not determine platform embedding the IP ("series7", "ultrascale" ?)"
    #endif
  #endif
#endif

#define IPECC_PHYS_SZ                   (4096) /* One page size */

#ifdef IPECC_PLATFORM_ULTRASCALE
  #define IPECC_DEV_UIO_IPECC             "/dev/uio4"
  #define IPECC_DEV_UIO_PSEUDOTRNG        "/dev/uio5"
#else
  #ifdef IPECC_PLATFORM_SERIES7
    #define IPECC_DEV_UIO_IPECC             "/dev/uio0"
    #define IPECC_DEV_UIO_PSEUDOTRNG        "/dev/uio1"
  #endif
#endif

/* Setup the driver depending on the environment.
 *
 * If 'pseudotrng_base_addr_p' is not NULL then the setup will also try
 * to open a device for the pseudo TRNG function, and return the mapped
 * address for this device in *pseudotrng_base_addr_p.
 *
 * Thus if the pseudo TRNG function is not needed, simply set NULL value
 * for 'pseudotrng_base_addr_p' argument and the setup won't try to acquire
 * nor map a corresponding hardware device.
 *
 * Now if the IP was synthesized in production (secure) mode, then the pseudo
 * TRNG function naturally does NOT exist and, in case the value passed for
 * parameter 'pseudotrng_base_addr_p' is not NULL, then *pseudotrng_base_addr_p
 * will be set with value NULL.
 */
int hw_driver_setup(volatile uint8_t **base_addr_p, volatile uint8_t **pseudotrng_base_addr_p)
{
	int ret = -1;

	if (base_addr_p == NULL) {
		ret = -1;
		goto err;
	}
#if defined(WITH_EC_HW_STANDALONE)
	{
		log_print("hw_driver_setup in standalone mode\n\r");
		/* In standalone mode, the base address
		 * is the physical one.
		 */
		(*base_addr_p)	     = (volatile uint8_t*)IPECC_PHYS_BADDR;
		if (pseudotrng_base_addr_p != NULL) {
			(*pseudotrng_base_addr_p) = (volatile uint8_t*)IPECC_PHYS_PSEUDO_TRNG_BADDR;
		}
	}							
#elif defined(WITH_EC_HW_UIO)
	{						
		int uio_fd0, uio_fd1;
		uint32_t uio_size;
		void *base_address;
		log_print("Driver in UIO mode\n\r");

		/* Handle the main ECC IP */
		/* Open our UIO device
		 * NOTE: O_SYNC here to avoid caching
		 */
		uio_fd0 = open(IPECC_DEV_UIO_IPECC, O_RDWR | O_SYNC);
		if(uio_fd0 == -1){
			printf("Error when opening %s\n\r", IPECC_DEV_UIO_IPECC);
			perror("open uio");
			ret = -1;
			goto err;
		}
		uio_size = IPECC_PHYS_SZ;
		base_address = mmap(NULL, uio_size, PROT_READ | PROT_WRITE, MAP_SHARED, uio_fd0, 0);
		if(base_address == MAP_FAILED){
			printf("Error during mmap!\n\r");
			perror("mmap uio");
			ret = -1;
			goto err;
		}
		(*base_addr_p) = base_address;

		if (pseudotrng_base_addr_p != NULL) {

			/* Now handle the pseudo-TRNG device. If the device does not exist (e.g the IP
			 * was not synthesized in HW unsecure mode, then the device simply won't exist,
			 * in which case we set *pseudotrng_base_addr_p = NULL.
			 */
			/* Open our UIO device
			 * NOTE: O_SYNC here to avoid caching
			 */
			uio_fd1 = open(IPECC_DEV_UIO_PSEUDOTRNG, O_RDWR | O_SYNC);
			if(uio_fd1 == -1){
				printf("Error when opening %s\n\r", IPECC_DEV_UIO_PSEUDOTRNG);
				perror("open uio");
				*pseudotrng_base_addr_p = NULL;
				ret = -1;
				goto err;
			}
			uio_size = IPECC_PHYS_SZ;
			base_address = mmap(NULL, uio_size, PROT_READ | PROT_WRITE, MAP_SHARED, uio_fd1, 0);
			if(base_address == MAP_FAILED){
				printf("Error during mmap!\n\r");
				perror("mmap uio");
				*pseudotrng_base_addr_p = NULL;
				ret = -1;
				goto err;
			}
			(*pseudotrng_base_addr_p) = base_address;
		}
	}
#elif defined(WITH_EC_HW_DEVMEM)
	{
		int devmem_fd;
		uint32_t devmem_size;
		void *base_address;
		log_print("Driver in /dev/mem mode\n\r");
		/* Open our /dev/mem device
		 * NOTE: O_SYNC here to avoid caching
		 */
		devmem_fd = open("/dev/mem", O_RDWR | O_SYNC);
		if(devmem_fd == -1){
			printf("Error when opening /dev/mem\n\r");
			perror("open devmem");
			ret = -1;
			goto err;
		}
		devmem_size = IPECC_PHYS_SZ;
		/* Map the main ECC IP */
		base_address = mmap(NULL, devmem_size, PROT_READ | PROT_WRITE, MAP_SHARED, devmem_fd, IPECC_PHYS_BADDR);
		if(base_address == MAP_FAILED){
			printf("Error during ECC IP mmap!\n\r");
			perror("mmap devmem ECC IP");
			ret = -1;
			goto err;
		}
		(*base_addr_p) = base_address;

		if (pseudotrng_base_addr_p != NULL) {

			/* Now handle the pseudo-TRNG device. If the device does not exist (e.g the IP
			 * was not synthesized in HW unsecure mode, then the device simply won't exist,
			 * in which case we set *pseudotrng_base_addr_p = NULL.
			 */
			devmem_size = IPECC_PHYS_SZ;
			/* Map the pseudo TRNG source device */
			base_address = mmap(NULL, devmem_size, PROT_READ | PROT_WRITE, MAP_SHARED, devmem_fd, IPECC_PHYS_PSEUDO_TRNG_BADDR);
			if(base_address == MAP_FAILED){
				printf("Error during pseudo TRNG device mmap!\n\r");
				perror("mmap devmem pseudo TRNG dev");
				*pseudotrng_base_addr_p = NULL;
				ret = -1;
				goto err;
			}
			(*pseudotrng_base_addr_p) = base_address;
		}
	}
#endif

	/* Log print in case of success */
	if (pseudotrng_base_addr_p != NULL) {
		if (*pseudotrng_base_addr_p != NULL) {
			log_print("OK, loaded IP @%p and Pseudo TRNG source @%p\n\r", (*base_addr_p), (*pseudotrng_base_addr_p));
		} else {
			log_print("OK, loaded IP @%p\n\r", (*base_addr_p));
		}
	}

	ret = 0;
err:
	return ret;
}

#else
/*
 * Dummy definition to avoid the empty translation unit ISO C warning
 */
typedef int dummy;
#endif /* WITH_EC_HW_ACCELERATOR */