src/include/tpm.h

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright 2011 Google Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc.
  18  */
  19
  20 #ifndef TPM_H_
  21 #define TPM_H_
  22
  23 #include <stddef.h>
  24 #include <stdint.h>
  25
  26 /*
  27  * tis_init()
  28  *
  29  * Initialize the TPM device. Returns 0 on success or -1 on
  30  * failure (in case device probing did not succeed).
  31  */
  32 int tis_init(void);
  33
  34 /*
  35  * tis_open()
  36  *
  37  * Requests access to locality 0 for the caller. After all commands have been
  38  * completed the caller is supposed to call tis_close().
  39  *
  40  * Returns 0 on success, -1 on failure.
  41  */
  42 int tis_open(void);
  43
  44 /*
  45  * tis_close()
  46  *
  47  * terminate the currect session with the TPM by releasing the locked
  48  * locality. Returns 0 on success of -1 on failure (in case lock
  49  * removal did not succeed).
  50  */
  51 int tis_close(void);
  52
  53 /*
  54  * tis_sendrecv()
  55  *
  56  * Send the requested data to the TPM and then try to get its response
  57  *
  58  * @sendbuf - buffer of the data to send
  59  * @send_size size of the data to send
  60  * @recvbuf - memory to save the response to
  61  * @recv_len - pointer to the size of the response buffer
  62  *
  63  * Returns 0 on success (and places the number of response bytes at recv_len)
  64  * or -1 on failure.
  65  */
  66 int tis_sendrecv(const u8 *sendbuf, size_t send_size, u8 *recvbuf,
  67                         size_t *recv_len);
  68
  69 void init_tpm(int s3resume);
  70
  71 #endif /* TPM_H_ */