libkeymaster/ver1/include/km_util.h

   1 /*
   2  * Copyright (c) 2015 TRUSTONIC LIMITED
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * 3. Neither the name of the TRUSTONIC LIMITED nor the names of its
  16  *    contributors may be used to endorse or promote products derived from
  17  *    this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef __KM_UTIL_H__
  33 #define __KM_UTIL_H__
  34
  35 #include <hardware/keymaster_defs.h>
  36
  37 #define LOG_TAG "TlcTeeKeyMaster"
  38 #include "log.h"
  39
  40 /**
  41  * Set \p ret to the return value of \p expr; if it is not \p KM_ERROR_OK then
  42  * log the error and go to \p end,
  43  */
  44 #define CHECK_RESULT_OK(expr) \
  45     do { \
  46         ret = (expr); \
  47         if (ret != KM_ERROR_OK) { \
  48             LOG_E("%s:%d: %s == %d", __func__, __LINE__, #expr, ret); \
  49             goto end; \
  50         } \
  51     } while (false)
  52
  53 #define CHECK_TRUE(errcode, expr) \
  54     do { \
  55         if (!(expr)) { \
  56             LOG_E("%s:%d: '%s' is false\n", __func__, __LINE__, #expr); \
  57             ret = (errcode); \
  58             goto end; \
  59         } \
  60     } while (false)
  61
  62 #define CHECK_NOT_NULL(expr) \
  63     CHECK_TRUE(KM_ERROR_UNEXPECTED_NULL_POINTER, (expr) != NULL)
  64
  65 /**
  66  * Get value of enumerated tag from key parameters
  67  */
  68 keymaster_error_t get_enumerated_tag(
  69     const keymaster_key_param_set_t *params,
  70     keymaster_tag_t tag,
  71     uint32_t *value);
  72
  73 /**
  74  * Get value of integer tag from key parameters
  75  */
  76 keymaster_error_t get_integer_tag(
  77     const keymaster_key_param_set_t *params,
  78     keymaster_tag_t tag,
  79     uint32_t *value);
  80
  81 /**
  82  * Get value of long integer tag from key parameters
  83  */
  84 keymaster_error_t get_long_integer_tag(
  85     const keymaster_key_param_set_t *params,
  86     keymaster_tag_t tag,
  87     uint64_t *value);
  88
  89 #endif /* __KM_UTIL_H__ */