2 * This file is part of the Chelsio T6 Crypto driver for Linux.
4 * Copyright (c) 2003-2017 Chelsio Communications, Inc. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * Written and Maintained by:
35 * Atul Gupta (atul.gupta@chelsio.com)
38 #define pr_fmt(fmt) "chcr:" fmt
40 #include <linux/kernel.h>
41 #include <linux/module.h>
42 #include <linux/crypto.h>
43 #include <linux/cryptohash.h>
44 #include <linux/skbuff.h>
45 #include <linux/rtnetlink.h>
46 #include <linux/highmem.h>
47 #include <linux/if_vlan.h>
49 #include <linux/netdevice.h>
52 #include <crypto/aes.h>
53 #include <crypto/algapi.h>
54 #include <crypto/hash.h>
55 #include <crypto/sha.h>
56 #include <crypto/authenc.h>
57 #include <crypto/internal/aead.h>
58 #include <crypto/null.h>
59 #include <crypto/internal/skcipher.h>
60 #include <crypto/aead.h>
61 #include <crypto/scatterwalk.h>
62 #include <crypto/internal/hash.h>
64 #include "chcr_core.h"
65 #include "chcr_algo.h"
66 #include "chcr_crypto.h"
69 * Max Tx descriptor space we allow for an Ethernet packet to be inlined
72 #define MAX_IMM_TX_PKT_LEN 256
73 #define GCM_ESP_IV_SIZE 8
75 static int chcr_xfrm_add_state(struct xfrm_state *x);
76 static void chcr_xfrm_del_state(struct xfrm_state *x);
77 static void chcr_xfrm_free_state(struct xfrm_state *x);
78 static bool chcr_ipsec_offload_ok(struct sk_buff *skb, struct xfrm_state *x);
80 static const struct xfrmdev_ops chcr_xfrmdev_ops = {
81 .xdo_dev_state_add = chcr_xfrm_add_state,
82 .xdo_dev_state_delete = chcr_xfrm_del_state,
83 .xdo_dev_state_free = chcr_xfrm_free_state,
84 .xdo_dev_offload_ok = chcr_ipsec_offload_ok,
87 /* Add offload xfrms to Chelsio Interface */
88 void chcr_add_xfrmops(const struct cxgb4_lld_info *lld)
90 struct net_device *netdev = NULL;
93 for (i = 0; i < lld->nports; i++) {
94 netdev = lld->ports[i];
97 netdev->xfrmdev_ops = &chcr_xfrmdev_ops;
98 netdev->hw_enc_features |= NETIF_F_HW_ESP;
99 netdev->features |= NETIF_F_HW_ESP;
101 netdev_change_features(netdev);
106 static inline int chcr_ipsec_setauthsize(struct xfrm_state *x,
107 struct ipsec_sa_entry *sa_entry)
110 int authsize = x->aead->alg_icv_len / 8;
112 sa_entry->authsize = authsize;
116 hmac_ctrl = CHCR_SCMD_HMAC_CTRL_DIV2;
119 hmac_ctrl = CHCR_SCMD_HMAC_CTRL_IPSEC_96BIT;
122 hmac_ctrl = CHCR_SCMD_HMAC_CTRL_NO_TRUNC;
130 static inline int chcr_ipsec_setkey(struct xfrm_state *x,
131 struct ipsec_sa_entry *sa_entry)
133 struct crypto_cipher *cipher;
134 int keylen = (x->aead->alg_key_len + 7) / 8;
135 unsigned char *key = x->aead->alg_key;
136 int ck_size, key_ctx_size = 0;
137 unsigned char ghash_h[AEAD_H_SIZE];
141 keylen -= 4; /* nonce/salt is present in the last 4 bytes */
142 memcpy(sa_entry->salt, key + keylen, 4);
145 if (keylen == AES_KEYSIZE_128) {
146 ck_size = CHCR_KEYCTX_CIPHER_KEY_SIZE_128;
147 } else if (keylen == AES_KEYSIZE_192) {
148 ck_size = CHCR_KEYCTX_CIPHER_KEY_SIZE_192;
149 } else if (keylen == AES_KEYSIZE_256) {
150 ck_size = CHCR_KEYCTX_CIPHER_KEY_SIZE_256;
152 pr_err("GCM: Invalid key length %d\n", keylen);
157 memcpy(sa_entry->key, key, keylen);
158 sa_entry->enckey_len = keylen;
159 key_ctx_size = sizeof(struct _key_ctx) +
160 ((DIV_ROUND_UP(keylen, 16)) << 4) +
163 sa_entry->key_ctx_hdr = FILL_KEY_CTX_HDR(ck_size,
164 CHCR_KEYCTX_MAC_KEY_SIZE_128,
168 /* Calculate the H = CIPH(K, 0 repeated 16 times).
169 * It will go in key context
171 cipher = crypto_alloc_cipher("aes-generic", 0, 0);
172 if (IS_ERR(cipher)) {
173 sa_entry->enckey_len = 0;
178 ret = crypto_cipher_setkey(cipher, key, keylen);
180 sa_entry->enckey_len = 0;
183 memset(ghash_h, 0, AEAD_H_SIZE);
184 crypto_cipher_encrypt_one(cipher, ghash_h, ghash_h);
185 memcpy(sa_entry->key + (DIV_ROUND_UP(sa_entry->enckey_len, 16) *
186 16), ghash_h, AEAD_H_SIZE);
187 sa_entry->kctx_len = ((DIV_ROUND_UP(sa_entry->enckey_len, 16)) << 4) +
190 crypto_free_cipher(cipher);
196 * chcr_xfrm_add_state
197 * returns 0 on success, negative error if failed to send message to FPGA
198 * positive error if FPGA returned a bad response
200 static int chcr_xfrm_add_state(struct xfrm_state *x)
202 struct ipsec_sa_entry *sa_entry;
205 if (x->props.aalgo != SADB_AALG_NONE) {
206 pr_debug("CHCR: Cannot offload authenticated xfrm states\n");
209 if (x->props.calgo != SADB_X_CALG_NONE) {
210 pr_debug("CHCR: Cannot offload compressed xfrm states\n");
213 if (x->props.flags & XFRM_STATE_ESN) {
214 pr_debug("CHCR: Cannot offload ESN xfrm states\n");
217 if (x->props.family != AF_INET &&
218 x->props.family != AF_INET6) {
219 pr_debug("CHCR: Only IPv4/6 xfrm state offloaded\n");
222 if (x->props.mode != XFRM_MODE_TRANSPORT &&
223 x->props.mode != XFRM_MODE_TUNNEL) {
224 pr_debug("CHCR: Only transport and tunnel xfrm offload\n");
227 if (x->id.proto != IPPROTO_ESP) {
228 pr_debug("CHCR: Only ESP xfrm state offloaded\n");
232 pr_debug("CHCR: Encapsulated xfrm state not offloaded\n");
236 pr_debug("CHCR: Cannot offload xfrm states without aead\n");
239 if (x->aead->alg_icv_len != 128 &&
240 x->aead->alg_icv_len != 96) {
241 pr_debug("CHCR: Cannot offload xfrm states with AEAD ICV length other than 96b & 128b\n");
244 if ((x->aead->alg_key_len != 128 + 32) &&
245 (x->aead->alg_key_len != 256 + 32)) {
246 pr_debug("CHCR: Cannot offload xfrm states with AEAD key length other than 128/256 bit\n");
250 pr_debug("CHCR: Cannot offload xfrm states with tfc padding\n");
254 pr_debug("CHCR: Cannot offload xfrm states without geniv\n");
257 if (strcmp(x->geniv, "seqiv")) {
258 pr_debug("CHCR: Cannot offload xfrm states with geniv other than seqiv\n");
262 sa_entry = kzalloc(sizeof(*sa_entry), GFP_KERNEL);
268 sa_entry->hmac_ctrl = chcr_ipsec_setauthsize(x, sa_entry);
269 chcr_ipsec_setkey(x, sa_entry);
270 x->xso.offload_handle = (unsigned long)sa_entry;
271 try_module_get(THIS_MODULE);
276 static void chcr_xfrm_del_state(struct xfrm_state *x)
279 if (!x->xso.offload_handle)
283 static void chcr_xfrm_free_state(struct xfrm_state *x)
285 struct ipsec_sa_entry *sa_entry;
287 if (!x->xso.offload_handle)
290 sa_entry = (struct ipsec_sa_entry *)x->xso.offload_handle;
292 module_put(THIS_MODULE);
295 static bool chcr_ipsec_offload_ok(struct sk_buff *skb, struct xfrm_state *x)
297 /* Offload with IP options is not supported yet */
298 if (ip_hdr(skb)->ihl > 5)
304 static inline int is_eth_imm(const struct sk_buff *skb, unsigned int kctx_len)
308 hdrlen = sizeof(struct fw_ulptx_wr) +
309 sizeof(struct chcr_ipsec_req) + kctx_len;
311 hdrlen += sizeof(struct cpl_tx_pkt);
312 if (skb->len <= MAX_IMM_TX_PKT_LEN - hdrlen)
317 static inline unsigned int calc_tx_sec_flits(const struct sk_buff *skb,
318 unsigned int kctx_len)
321 int hdrlen = is_eth_imm(skb, kctx_len);
323 /* If the skb is small enough, we can pump it out as a work request
324 * with only immediate data. In that case we just have to have the
325 * TX Packet header plus the skb data in the Work Request.
329 return DIV_ROUND_UP(skb->len + hdrlen, sizeof(__be64));
331 flits = sgl_len(skb_shinfo(skb)->nr_frags + 1);
333 /* Otherwise, we're going to have to construct a Scatter gather list
334 * of the skb body and fragments. We also include the flits necessary
335 * for the TX Packet Work Request and CPL. We always have a firmware
336 * Write Header (incorporated as part of the cpl_tx_pkt_lso and
337 * cpl_tx_pkt structures), followed by either a TX Packet Write CPL
338 * message or, if we're doing a Large Send Offload, an LSO CPL message
339 * with an embedded TX Packet Write CPL message.
341 flits += (sizeof(struct fw_ulptx_wr) +
342 sizeof(struct chcr_ipsec_req) +
344 sizeof(struct cpl_tx_pkt_core)) / sizeof(__be64);
348 inline void *copy_cpltx_pktxt(struct sk_buff *skb,
349 struct net_device *dev,
352 struct cpl_tx_pkt_core *cpl;
353 struct sge_eth_txq *q;
354 struct adapter *adap;
355 struct port_info *pi;
360 pi = netdev_priv(dev);
362 qidx = skb->queue_mapping;
363 q = &adap->sge.ethtxq[qidx + pi->first_qset];
365 left = (void *)q->q.stat - pos;
369 cpl = (struct cpl_tx_pkt_core *)pos;
371 cntrl = TXPKT_L4CSUM_DIS_F | TXPKT_IPCSUM_DIS_F;
372 ctrl0 = TXPKT_OPCODE_V(CPL_TX_PKT_XT) | TXPKT_INTF_V(pi->tx_chan) |
373 TXPKT_PF_V(adap->pf);
374 if (skb_vlan_tag_present(skb)) {
376 cntrl |= TXPKT_VLAN_VLD_F | TXPKT_VLAN_V(skb_vlan_tag_get(skb));
379 cpl->ctrl0 = htonl(ctrl0);
380 cpl->pack = htons(0);
381 cpl->len = htons(skb->len);
382 cpl->ctrl1 = cpu_to_be64(cntrl);
384 pos += sizeof(struct cpl_tx_pkt_core);
388 inline void *copy_key_cpltx_pktxt(struct sk_buff *skb,
389 struct net_device *dev,
391 struct ipsec_sa_entry *sa_entry)
393 struct _key_ctx *key_ctx;
394 int left, eoq, key_len;
395 struct sge_eth_txq *q;
396 struct adapter *adap;
397 struct port_info *pi;
400 pi = netdev_priv(dev);
402 qidx = skb->queue_mapping;
403 q = &adap->sge.ethtxq[qidx + pi->first_qset];
404 key_len = sa_entry->kctx_len;
406 /* end of queue, reset pos to start of queue */
407 eoq = (void *)q->q.stat - pos;
411 left = 64 * q->q.size;
414 /* Copy the Key context header */
415 key_ctx = (struct _key_ctx *)pos;
416 key_ctx->ctx_hdr = sa_entry->key_ctx_hdr;
417 memcpy(key_ctx->salt, sa_entry->salt, MAX_SALT);
418 pos += sizeof(struct _key_ctx);
419 left -= sizeof(struct _key_ctx);
421 if (likely(key_len <= left)) {
422 memcpy(key_ctx->key, sa_entry->key, key_len);
425 memcpy(pos, sa_entry->key, left);
426 memcpy(q->q.desc, sa_entry->key + left,
428 pos = (u8 *)q->q.desc + (key_len - left);
430 /* Copy CPL TX PKT XT */
431 pos = copy_cpltx_pktxt(skb, dev, pos);
436 inline void *chcr_crypto_wreq(struct sk_buff *skb,
437 struct net_device *dev,
440 struct ipsec_sa_entry *sa_entry)
442 struct port_info *pi = netdev_priv(dev);
443 struct adapter *adap = pi->adapter;
444 unsigned int immdatalen = 0;
445 unsigned int ivsize = GCM_ESP_IV_SIZE;
446 struct chcr_ipsec_wr *wr;
449 int qidx = skb_get_queue_mapping(skb);
450 struct sge_eth_txq *q = &adap->sge.ethtxq[qidx + pi->first_qset];
451 unsigned int kctx_len = sa_entry->kctx_len;
452 int qid = q->q.cntxt_id;
454 atomic_inc(&adap->chcr_stats.ipsec_cnt);
456 flits = calc_tx_sec_flits(skb, kctx_len);
458 if (is_eth_imm(skb, kctx_len))
459 immdatalen = skb->len;
462 wr = (struct chcr_ipsec_wr *)pos;
463 wr->wreq.op_to_compl = htonl(FW_WR_OP_V(FW_ULPTX_WR));
464 wr_mid = FW_CRYPTO_LOOKASIDE_WR_LEN16_V(DIV_ROUND_UP(flits, 2));
466 if (unlikely(credits < ETHTXQ_STOP_THRES)) {
467 netif_tx_stop_queue(q->txq);
469 wr_mid |= FW_WR_EQUEQ_F | FW_WR_EQUIQ_F;
471 wr_mid |= FW_ULPTX_WR_DATA_F;
472 wr->wreq.flowid_len16 = htonl(wr_mid);
475 wr->req.ulptx.cmd_dest = FILL_ULPTX_CMD_DEST(pi->port_id, qid);
476 wr->req.ulptx.len = htonl(DIV_ROUND_UP(flits, 2) - 1);
479 wr->req.sc_imm.cmd_more = FILL_CMD_MORE(!immdatalen);
480 wr->req.sc_imm.len = cpu_to_be32(sizeof(struct cpl_tx_sec_pdu) +
481 sizeof(wr->req.key_ctx) +
483 sizeof(struct cpl_tx_pkt_core) +
487 wr->req.sec_cpl.op_ivinsrtofst = htonl(
488 CPL_TX_SEC_PDU_OPCODE_V(CPL_TX_SEC_PDU) |
489 CPL_TX_SEC_PDU_CPLLEN_V(2) |
490 CPL_TX_SEC_PDU_PLACEHOLDER_V(1) |
491 CPL_TX_SEC_PDU_IVINSRTOFST_V(
492 (skb_transport_offset(skb) +
493 sizeof(struct ip_esp_hdr) + 1)));
495 wr->req.sec_cpl.pldlen = htonl(skb->len);
497 wr->req.sec_cpl.aadstart_cipherstop_hi = FILL_SEC_CPL_CIPHERSTOP_HI(
498 (skb_transport_offset(skb) + 1),
499 (skb_transport_offset(skb) +
500 sizeof(struct ip_esp_hdr)),
501 (skb_transport_offset(skb) +
502 sizeof(struct ip_esp_hdr) +
503 GCM_ESP_IV_SIZE + 1), 0);
505 wr->req.sec_cpl.cipherstop_lo_authinsert =
506 FILL_SEC_CPL_AUTHINSERT(0, skb_transport_offset(skb) +
507 sizeof(struct ip_esp_hdr) +
511 wr->req.sec_cpl.seqno_numivs =
512 FILL_SEC_CPL_SCMD0_SEQNO(CHCR_ENCRYPT_OP, 1,
513 CHCR_SCMD_CIPHER_MODE_AES_GCM,
514 CHCR_SCMD_AUTH_MODE_GHASH,
517 wr->req.sec_cpl.ivgen_hdrlen = FILL_SEC_CPL_IVGEN_HDRLEN(0, 0, 1,
520 pos += sizeof(struct fw_ulptx_wr) +
521 sizeof(struct ulp_txpkt) +
522 sizeof(struct ulptx_idata) +
523 sizeof(struct cpl_tx_sec_pdu);
525 pos = copy_key_cpltx_pktxt(skb, dev, pos, sa_entry);
531 * flits_to_desc - returns the num of Tx descriptors for the given flits
532 * @n: the number of flits
534 * Returns the number of Tx descriptors needed for the supplied number
537 static inline unsigned int flits_to_desc(unsigned int n)
539 WARN_ON(n > SGE_MAX_WR_LEN / 8);
540 return DIV_ROUND_UP(n, 8);
543 static inline unsigned int txq_avail(const struct sge_txq *q)
545 return q->size - 1 - q->in_use;
548 static void eth_txq_stop(struct sge_eth_txq *q)
550 netif_tx_stop_queue(q->txq);
554 static inline void txq_advance(struct sge_txq *q, unsigned int n)
558 if (q->pidx >= q->size)
563 * chcr_ipsec_xmit called from ULD Tx handler
565 int chcr_ipsec_xmit(struct sk_buff *skb, struct net_device *dev)
567 struct xfrm_state *x = xfrm_input_state(skb);
568 struct ipsec_sa_entry *sa_entry;
569 u64 *pos, *end, *before, *sgl;
570 int qidx, left, credits;
571 unsigned int flits = 0, ndesc, kctx_len;
572 struct adapter *adap;
573 struct sge_eth_txq *q;
574 struct port_info *pi;
575 dma_addr_t addr[MAX_SKB_FRAGS + 1];
576 bool immediate = false;
578 if (!x->xso.offload_handle)
579 return NETDEV_TX_BUSY;
581 sa_entry = (struct ipsec_sa_entry *)x->xso.offload_handle;
582 kctx_len = sa_entry->kctx_len;
584 if (skb->sp->len != 1) {
585 out_free: dev_kfree_skb_any(skb);
589 pi = netdev_priv(dev);
591 qidx = skb->queue_mapping;
592 q = &adap->sge.ethtxq[qidx + pi->first_qset];
594 cxgb4_reclaim_completed_tx(adap, &q->q, true);
596 flits = calc_tx_sec_flits(skb, sa_entry->kctx_len);
597 ndesc = flits_to_desc(flits);
598 credits = txq_avail(&q->q) - ndesc;
600 if (unlikely(credits < 0)) {
602 dev_err(adap->pdev_dev,
603 "%s: Tx ring %u full while queue awake! cred:%d %d %d flits:%d\n",
604 dev->name, qidx, credits, ndesc, txq_avail(&q->q),
606 return NETDEV_TX_BUSY;
609 if (is_eth_imm(skb, kctx_len))
613 unlikely(cxgb4_map_skb(adap->pdev_dev, skb, addr) < 0)) {
618 pos = (u64 *)&q->q.desc[q->q.pidx];
620 end = (u64 *)pos + flits;
621 /* Setup IPSec CPL */
622 pos = (void *)chcr_crypto_wreq(skb, dev, (void *)pos,
624 if (before > (u64 *)pos) {
625 left = (u8 *)end - (u8 *)q->q.stat;
626 end = (void *)q->q.desc + left;
628 if (pos == (u64 *)q->q.stat) {
629 left = (u8 *)end - (u8 *)q->q.stat;
630 end = (void *)q->q.desc + left;
631 pos = (void *)q->q.desc;
636 cxgb4_inline_tx_skb(skb, &q->q, sgl);
637 dev_consume_skb_any(skb);
641 cxgb4_write_sgl(skb, &q->q, (void *)sgl, end,
645 last_desc = q->q.pidx + ndesc - 1;
646 if (last_desc >= q->q.size)
647 last_desc -= q->q.size;
648 q->q.sdesc[last_desc].skb = skb;
649 q->q.sdesc[last_desc].sgl = (struct ulptx_sgl *)sgl;
651 txq_advance(&q->q, ndesc);
653 cxgb4_ring_tx_db(adap, &q->q, ndesc);