include/crypto/engine.h

   1 /*
   2  * Crypto engine API
   3  *
   4  * Copyright (c) 2016 Baolin Wang <baolin.wang@linaro.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; either version 2 of the License, or (at your option)
   9  * any later version.
  10  *
  11  */
  12 #ifndef _CRYPTO_ENGINE_H
  13 #define _CRYPTO_ENGINE_H
  14
  15 #include <linux/crypto.h>
  16 #include <linux/list.h>
  17 #include <linux/kernel.h>
  18 #include <linux/kthread.h>
  19 #include <crypto/algapi.h>
  20 #include <crypto/hash.h>
  21
  22 #define ENGINE_NAME_LEN 30
  23 /*
  24  * struct crypto_engine - crypto hardware engine
  25  * @name: the engine name
  26  * @idling: the engine is entering idle state
  27  * @busy: request pump is busy
  28  * @running: the engine is on working
  29  * @cur_req_prepared: current request is prepared
  30  * @list: link with the global crypto engine list
  31  * @queue_lock: spinlock to syncronise access to request queue
  32  * @queue: the crypto queue of the engine
  33  * @rt: whether this queue is set to run as a realtime task
  34  * @prepare_crypt_hardware: a request will soon arrive from the queue
  35  * so the subsystem requests the driver to prepare the hardware
  36  * by issuing this call
  37  * @unprepare_crypt_hardware: there are currently no more requests on the
  38  * queue so the subsystem notifies the driver that it may relax the
  39  * hardware by issuing this call
  40  * @prepare_cipher_request: do some prepare if need before handle the current request
  41  * @unprepare_cipher_request: undo any work done by prepare_cipher_request()
  42  * @cipher_one_request: do encryption for current request
  43  * @prepare_hash_request: do some prepare if need before handle the current request
  44  * @unprepare_hash_request: undo any work done by prepare_hash_request()
  45  * @hash_one_request: do hash for current request
  46  * @kworker: thread struct for request pump
  47  * @kworker_task: pointer to task for request pump kworker thread
  48  * @pump_requests: work struct for scheduling work to the request pump
  49  * @priv_data: the engine private data
  50  * @cur_req: the current request which is on processing
  51  */
  52 struct crypto_engine {
  53         char                    name[ENGINE_NAME_LEN];
  54         bool                    idling;
  55         bool                    busy;
  56         bool                    running;
  57         bool                    cur_req_prepared;
  58
  59         struct list_head        list;
  60         spinlock_t              queue_lock;
  61         struct crypto_queue     queue;
  62
  63         bool                    rt;
  64
  65         int (*prepare_crypt_hardware)(struct crypto_engine *engine);
  66         int (*unprepare_crypt_hardware)(struct crypto_engine *engine);
  67
  68         int (*prepare_cipher_request)(struct crypto_engine *engine,
  69                                       struct ablkcipher_request *req);
  70         int (*unprepare_cipher_request)(struct crypto_engine *engine,
  71                                         struct ablkcipher_request *req);
  72         int (*prepare_hash_request)(struct crypto_engine *engine,
  73                                     struct ahash_request *req);
  74         int (*unprepare_hash_request)(struct crypto_engine *engine,
  75                                       struct ahash_request *req);
  76         int (*cipher_one_request)(struct crypto_engine *engine,
  77                                   struct ablkcipher_request *req);
  78         int (*hash_one_request)(struct crypto_engine *engine,
  79                                 struct ahash_request *req);
  80
  81         struct kthread_worker           kworker;
  82         struct task_struct              *kworker_task;
  83         struct kthread_work             pump_requests;
  84
  85         void                            *priv_data;
  86         struct crypto_async_request     *cur_req;
  87 };
  88
  89 int crypto_transfer_cipher_request(struct crypto_engine *engine,
  90                                    struct ablkcipher_request *req,
  91                                    bool need_pump);
  92 int crypto_transfer_cipher_request_to_engine(struct crypto_engine *engine,
  93                                              struct ablkcipher_request *req);
  94 int crypto_transfer_hash_request(struct crypto_engine *engine,
  95                                  struct ahash_request *req, bool need_pump);
  96 int crypto_transfer_hash_request_to_engine(struct crypto_engine *engine,
  97                                            struct ahash_request *req);
  98 void crypto_finalize_cipher_request(struct crypto_engine *engine,
  99                                     struct ablkcipher_request *req, int err);
 100 void crypto_finalize_hash_request(struct crypto_engine *engine,
 101                                   struct ahash_request *req, int err);
 102 int crypto_engine_start(struct crypto_engine *engine);
 103 int crypto_engine_stop(struct crypto_engine *engine);
 104 struct crypto_engine *crypto_engine_alloc_init(struct device *dev, bool rt);
 105 int crypto_engine_exit(struct crypto_engine *engine);
 106
 107 #endif /* _CRYPTO_ENGINE_H */