1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright(c) 2018 Oracle and/or its affiliates. All rights reserved. */
6 #include <crypto/aead.h>
8 #define IXGBE_IPSEC_KEY_BITS 160
9 static const char aes_gcm_name[] = "rfc4106(gcm(aes))";
12 * ixgbevf_ipsec_set_pf_sa - ask the PF to set up an SA
13 * @adapter: board private structure
14 * @xs: xfrm info to be sent to the PF
16 * Returns: positive offload handle from the PF, or negative error code
18 static int ixgbevf_ipsec_set_pf_sa(struct ixgbevf_adapter *adapter,
19 struct xfrm_state *xs)
21 u32 msgbuf[IXGBE_VFMAILBOX_SIZE] = { 0 };
22 struct ixgbe_hw *hw = &adapter->hw;
23 struct sa_mbx_msg *sam;
26 /* send the important bits to the PF */
27 sam = (struct sa_mbx_msg *)(&msgbuf[1]);
28 sam->flags = xs->xso.flags;
29 sam->spi = xs->id.spi;
30 sam->proto = xs->id.proto;
31 sam->family = xs->props.family;
33 if (xs->props.family == AF_INET6)
34 memcpy(sam->addr, &xs->id.daddr.a6, sizeof(xs->id.daddr.a6));
36 memcpy(sam->addr, &xs->id.daddr.a4, sizeof(xs->id.daddr.a4));
37 memcpy(sam->key, xs->aead->alg_key, sizeof(sam->key));
39 msgbuf[0] = IXGBE_VF_IPSEC_ADD;
41 spin_lock_bh(&adapter->mbx_lock);
43 ret = hw->mbx.ops.write_posted(hw, msgbuf, IXGBE_VFMAILBOX_SIZE);
47 ret = hw->mbx.ops.read_posted(hw, msgbuf, 2);
52 if (msgbuf[0] & IXGBE_VT_MSGTYPE_NACK && ret >= 0)
56 spin_unlock_bh(&adapter->mbx_lock);
62 * ixgbevf_ipsec_del_pf_sa - ask the PF to delete an SA
63 * @adapter: board private structure
64 * @pfsa: sa index returned from PF when created, -1 for all
66 * Returns: 0 on success, or negative error code
68 static int ixgbevf_ipsec_del_pf_sa(struct ixgbevf_adapter *adapter, int pfsa)
70 struct ixgbe_hw *hw = &adapter->hw;
74 memset(msgbuf, 0, sizeof(msgbuf));
75 msgbuf[0] = IXGBE_VF_IPSEC_DEL;
76 msgbuf[1] = (u32)pfsa;
78 spin_lock_bh(&adapter->mbx_lock);
80 err = hw->mbx.ops.write_posted(hw, msgbuf, 2);
84 err = hw->mbx.ops.read_posted(hw, msgbuf, 2);
89 spin_unlock_bh(&adapter->mbx_lock);
94 * ixgbevf_ipsec_restore - restore the IPsec HW settings after a reset
95 * @adapter: board private structure
97 * Reload the HW tables from the SW tables after they've been bashed
98 * by a chip reset. While we're here, make sure any stale VF data is
99 * removed, since we go through reset when num_vfs changes.
101 void ixgbevf_ipsec_restore(struct ixgbevf_adapter *adapter)
103 struct ixgbevf_ipsec *ipsec = adapter->ipsec;
104 struct net_device *netdev = adapter->netdev;
107 if (!(adapter->netdev->features & NETIF_F_HW_ESP))
110 /* reload the Rx and Tx keys */
111 for (i = 0; i < IXGBE_IPSEC_MAX_SA_COUNT; i++) {
112 struct rx_sa *r = &ipsec->rx_tbl[i];
113 struct tx_sa *t = &ipsec->tx_tbl[i];
117 ret = ixgbevf_ipsec_set_pf_sa(adapter, r->xs);
119 netdev_err(netdev, "reload rx_tbl[%d] failed = %d\n",
124 ret = ixgbevf_ipsec_set_pf_sa(adapter, t->xs);
126 netdev_err(netdev, "reload tx_tbl[%d] failed = %d\n",
133 * ixgbevf_ipsec_find_empty_idx - find the first unused security parameter index
134 * @ipsec: pointer to IPsec struct
135 * @rxtable: true if we need to look in the Rx table
137 * Returns the first unused index in either the Rx or Tx SA table
140 int ixgbevf_ipsec_find_empty_idx(struct ixgbevf_ipsec *ipsec, bool rxtable)
145 if (ipsec->num_rx_sa == IXGBE_IPSEC_MAX_SA_COUNT)
148 /* search rx sa table */
149 for (i = 0; i < IXGBE_IPSEC_MAX_SA_COUNT; i++) {
150 if (!ipsec->rx_tbl[i].used)
154 if (ipsec->num_tx_sa == IXGBE_IPSEC_MAX_SA_COUNT)
157 /* search tx sa table */
158 for (i = 0; i < IXGBE_IPSEC_MAX_SA_COUNT; i++) {
159 if (!ipsec->tx_tbl[i].used)
168 * ixgbevf_ipsec_find_rx_state - find the state that matches
169 * @ipsec: pointer to IPsec struct
170 * @daddr: inbound address to match
171 * @proto: protocol to match
173 * @ip4: true if using an IPv4 address
175 * Returns a pointer to the matching SA state information
178 struct xfrm_state *ixgbevf_ipsec_find_rx_state(struct ixgbevf_ipsec *ipsec,
179 __be32 *daddr, u8 proto,
180 __be32 spi, bool ip4)
182 struct xfrm_state *ret = NULL;
186 hash_for_each_possible_rcu(ipsec->rx_sa_list, rsa, hlist,
188 if (spi == rsa->xs->id.spi &&
189 ((ip4 && *daddr == rsa->xs->id.daddr.a4) ||
190 (!ip4 && !memcmp(daddr, &rsa->xs->id.daddr.a6,
191 sizeof(rsa->xs->id.daddr.a6)))) &&
192 proto == rsa->xs->id.proto) {
194 xfrm_state_hold(ret);
203 * ixgbevf_ipsec_parse_proto_keys - find the key and salt based on the protocol
204 * @xs: pointer to xfrm_state struct
205 * @mykey: pointer to key array to populate
206 * @mysalt: pointer to salt value to populate
208 * This copies the protocol keys and salt to our own data tables. The
209 * 82599 family only supports the one algorithm.
211 static int ixgbevf_ipsec_parse_proto_keys(struct xfrm_state *xs,
212 u32 *mykey, u32 *mysalt)
214 struct net_device *dev = xs->xso.real_dev;
215 unsigned char *key_data;
216 char *alg_name = NULL;
220 netdev_err(dev, "Unsupported IPsec algorithm\n");
224 if (xs->aead->alg_icv_len != IXGBE_IPSEC_AUTH_BITS) {
225 netdev_err(dev, "IPsec offload requires %d bit authentication\n",
226 IXGBE_IPSEC_AUTH_BITS);
230 key_data = &xs->aead->alg_key[0];
231 key_len = xs->aead->alg_key_len;
232 alg_name = xs->aead->alg_name;
234 if (strcmp(alg_name, aes_gcm_name)) {
235 netdev_err(dev, "Unsupported IPsec algorithm - please use %s\n",
240 /* The key bytes come down in a big endian array of bytes, so
241 * we don't need to do any byte swapping.
242 * 160 accounts for 16 byte key and 4 byte salt
244 if (key_len > IXGBE_IPSEC_KEY_BITS) {
245 *mysalt = ((u32 *)key_data)[4];
246 } else if (key_len == IXGBE_IPSEC_KEY_BITS) {
249 netdev_err(dev, "IPsec hw offload only supports keys up to 128 bits with a 32 bit salt\n");
252 memcpy(mykey, key_data, 16);
258 * ixgbevf_ipsec_add_sa - program device with a security association
259 * @xs: pointer to transformer state struct
261 static int ixgbevf_ipsec_add_sa(struct xfrm_state *xs)
263 struct net_device *dev = xs->xso.real_dev;
264 struct ixgbevf_adapter *adapter;
265 struct ixgbevf_ipsec *ipsec;
269 adapter = netdev_priv(dev);
270 ipsec = adapter->ipsec;
272 if (xs->id.proto != IPPROTO_ESP && xs->id.proto != IPPROTO_AH) {
273 netdev_err(dev, "Unsupported protocol 0x%04x for IPsec offload\n",
278 if (xs->props.mode != XFRM_MODE_TRANSPORT) {
279 netdev_err(dev, "Unsupported mode for ipsec offload\n");
283 if (xs->xso.flags & XFRM_OFFLOAD_INBOUND) {
287 netdev_err(dev, "Compression offload not supported\n");
291 /* find the first unused index */
292 ret = ixgbevf_ipsec_find_empty_idx(ipsec, true);
294 netdev_err(dev, "No space for SA in Rx table!\n");
299 memset(&rsa, 0, sizeof(rsa));
303 if (rsa.xs->id.proto & IPPROTO_ESP)
304 rsa.decrypt = xs->ealg || xs->aead;
306 /* get the key and salt */
307 ret = ixgbevf_ipsec_parse_proto_keys(xs, rsa.key, &rsa.salt);
309 netdev_err(dev, "Failed to get key data for Rx SA table\n");
313 /* get ip for rx sa table */
314 if (xs->props.family == AF_INET6)
315 memcpy(rsa.ipaddr, &xs->id.daddr.a6, 16);
317 memcpy(&rsa.ipaddr[3], &xs->id.daddr.a4, 4);
319 rsa.mode = IXGBE_RXMOD_VALID;
320 if (rsa.xs->id.proto & IPPROTO_ESP)
321 rsa.mode |= IXGBE_RXMOD_PROTO_ESP;
323 rsa.mode |= IXGBE_RXMOD_DECRYPT;
324 if (rsa.xs->props.family == AF_INET6)
325 rsa.mode |= IXGBE_RXMOD_IPV6;
327 ret = ixgbevf_ipsec_set_pf_sa(adapter, xs);
332 /* the preparations worked, so save the info */
333 memcpy(&ipsec->rx_tbl[sa_idx], &rsa, sizeof(rsa));
335 xs->xso.offload_handle = sa_idx + IXGBE_IPSEC_BASE_RX_INDEX;
339 /* hash the new entry for faster search in Rx path */
340 hash_add_rcu(ipsec->rx_sa_list, &ipsec->rx_tbl[sa_idx].hlist,
341 (__force u32)rsa.xs->id.spi);
345 /* find the first unused index */
346 ret = ixgbevf_ipsec_find_empty_idx(ipsec, false);
348 netdev_err(dev, "No space for SA in Tx table\n");
353 memset(&tsa, 0, sizeof(tsa));
357 if (xs->id.proto & IPPROTO_ESP)
358 tsa.encrypt = xs->ealg || xs->aead;
360 ret = ixgbevf_ipsec_parse_proto_keys(xs, tsa.key, &tsa.salt);
362 netdev_err(dev, "Failed to get key data for Tx SA table\n");
363 memset(&tsa, 0, sizeof(tsa));
367 ret = ixgbevf_ipsec_set_pf_sa(adapter, xs);
372 /* the preparations worked, so save the info */
373 memcpy(&ipsec->tx_tbl[sa_idx], &tsa, sizeof(tsa));
375 xs->xso.offload_handle = sa_idx + IXGBE_IPSEC_BASE_TX_INDEX;
384 * ixgbevf_ipsec_del_sa - clear out this specific SA
385 * @xs: pointer to transformer state struct
387 static void ixgbevf_ipsec_del_sa(struct xfrm_state *xs)
389 struct net_device *dev = xs->xso.real_dev;
390 struct ixgbevf_adapter *adapter;
391 struct ixgbevf_ipsec *ipsec;
394 adapter = netdev_priv(dev);
395 ipsec = adapter->ipsec;
397 if (xs->xso.flags & XFRM_OFFLOAD_INBOUND) {
398 sa_idx = xs->xso.offload_handle - IXGBE_IPSEC_BASE_RX_INDEX;
400 if (!ipsec->rx_tbl[sa_idx].used) {
401 netdev_err(dev, "Invalid Rx SA selected sa_idx=%d offload_handle=%lu\n",
402 sa_idx, xs->xso.offload_handle);
406 ixgbevf_ipsec_del_pf_sa(adapter, ipsec->rx_tbl[sa_idx].pfsa);
407 hash_del_rcu(&ipsec->rx_tbl[sa_idx].hlist);
408 memset(&ipsec->rx_tbl[sa_idx], 0, sizeof(struct rx_sa));
411 sa_idx = xs->xso.offload_handle - IXGBE_IPSEC_BASE_TX_INDEX;
413 if (!ipsec->tx_tbl[sa_idx].used) {
414 netdev_err(dev, "Invalid Tx SA selected sa_idx=%d offload_handle=%lu\n",
415 sa_idx, xs->xso.offload_handle);
419 ixgbevf_ipsec_del_pf_sa(adapter, ipsec->tx_tbl[sa_idx].pfsa);
420 memset(&ipsec->tx_tbl[sa_idx], 0, sizeof(struct tx_sa));
426 * ixgbevf_ipsec_offload_ok - can this packet use the xfrm hw offload
427 * @skb: current data packet
428 * @xs: pointer to transformer state struct
430 static bool ixgbevf_ipsec_offload_ok(struct sk_buff *skb, struct xfrm_state *xs)
432 if (xs->props.family == AF_INET) {
433 /* Offload with IPv4 options is not supported yet */
434 if (ip_hdr(skb)->ihl != 5)
437 /* Offload with IPv6 extension headers is not support yet */
438 if (ipv6_ext_hdr(ipv6_hdr(skb)->nexthdr))
445 static const struct xfrmdev_ops ixgbevf_xfrmdev_ops = {
446 .xdo_dev_state_add = ixgbevf_ipsec_add_sa,
447 .xdo_dev_state_delete = ixgbevf_ipsec_del_sa,
448 .xdo_dev_offload_ok = ixgbevf_ipsec_offload_ok,
452 * ixgbevf_ipsec_tx - setup Tx flags for IPsec offload
453 * @tx_ring: outgoing context
454 * @first: current data packet
455 * @itd: ipsec Tx data for later use in building context descriptor
457 int ixgbevf_ipsec_tx(struct ixgbevf_ring *tx_ring,
458 struct ixgbevf_tx_buffer *first,
459 struct ixgbevf_ipsec_tx_data *itd)
461 struct ixgbevf_adapter *adapter = netdev_priv(tx_ring->netdev);
462 struct ixgbevf_ipsec *ipsec = adapter->ipsec;
463 struct xfrm_state *xs;
468 sp = skb_sec_path(first->skb);
469 if (unlikely(!sp->len)) {
470 netdev_err(tx_ring->netdev, "%s: no xfrm state len = %d\n",
475 xs = xfrm_input_state(first->skb);
477 netdev_err(tx_ring->netdev, "%s: no xfrm_input_state() xs = %p\n",
482 sa_idx = xs->xso.offload_handle - IXGBE_IPSEC_BASE_TX_INDEX;
483 if (unlikely(sa_idx >= IXGBE_IPSEC_MAX_SA_COUNT)) {
484 netdev_err(tx_ring->netdev, "%s: bad sa_idx=%d handle=%lu\n",
485 __func__, sa_idx, xs->xso.offload_handle);
489 tsa = &ipsec->tx_tbl[sa_idx];
490 if (unlikely(!tsa->used)) {
491 netdev_err(tx_ring->netdev, "%s: unused sa_idx=%d\n",
496 itd->pfsa = tsa->pfsa - IXGBE_IPSEC_BASE_TX_INDEX;
498 first->tx_flags |= IXGBE_TX_FLAGS_IPSEC | IXGBE_TX_FLAGS_CSUM;
500 if (xs->id.proto == IPPROTO_ESP) {
501 itd->flags |= IXGBE_ADVTXD_TUCMD_IPSEC_TYPE_ESP |
502 IXGBE_ADVTXD_TUCMD_L4T_TCP;
503 if (first->protocol == htons(ETH_P_IP))
504 itd->flags |= IXGBE_ADVTXD_TUCMD_IPV4;
506 /* The actual trailer length is authlen (16 bytes) plus
507 * 2 bytes for the proto and the padlen values, plus
508 * padlen bytes of padding. This ends up not the same
509 * as the static value found in xs->props.trailer_len (21).
511 * ... but if we're doing GSO, don't bother as the stack
512 * doesn't add a trailer for those.
514 if (!skb_is_gso(first->skb)) {
515 /* The "correct" way to get the auth length would be
517 * authlen = crypto_aead_authsize(xs->data);
518 * but since we know we only have one size to worry
519 * about * we can let the compiler use the constant
520 * and save us a few CPU cycles.
522 const int authlen = IXGBE_IPSEC_AUTH_BITS / 8;
523 struct sk_buff *skb = first->skb;
527 ret = skb_copy_bits(skb, skb->len - (authlen + 2),
531 itd->trailer_len = authlen + 2 + padlen;
535 itd->flags |= IXGBE_ADVTXD_TUCMD_IPSEC_ENCRYPT_EN;
541 * ixgbevf_ipsec_rx - decode IPsec bits from Rx descriptor
542 * @rx_ring: receiving ring
543 * @rx_desc: receive data descriptor
544 * @skb: current data packet
546 * Determine if there was an IPsec encapsulation noticed, and if so set up
547 * the resulting status for later in the receive stack.
549 void ixgbevf_ipsec_rx(struct ixgbevf_ring *rx_ring,
550 union ixgbe_adv_rx_desc *rx_desc,
553 struct ixgbevf_adapter *adapter = netdev_priv(rx_ring->netdev);
554 __le16 pkt_info = rx_desc->wb.lower.lo_dword.hs_rss.pkt_info;
555 __le16 ipsec_pkt_types = cpu_to_le16(IXGBE_RXDADV_PKTTYPE_IPSEC_AH |
556 IXGBE_RXDADV_PKTTYPE_IPSEC_ESP);
557 struct ixgbevf_ipsec *ipsec = adapter->ipsec;
558 struct xfrm_offload *xo = NULL;
559 struct xfrm_state *xs = NULL;
560 struct ipv6hdr *ip6 = NULL;
561 struct iphdr *ip4 = NULL;
568 /* Find the IP and crypto headers in the data.
569 * We can assume no VLAN header in the way, b/c the
570 * hw won't recognize the IPsec packet and anyway the
571 * currently VLAN device doesn't support xfrm offload.
573 if (pkt_info & cpu_to_le16(IXGBE_RXDADV_PKTTYPE_IPV4)) {
574 ip4 = (struct iphdr *)(skb->data + ETH_HLEN);
576 c_hdr = (u8 *)ip4 + ip4->ihl * 4;
577 } else if (pkt_info & cpu_to_le16(IXGBE_RXDADV_PKTTYPE_IPV6)) {
578 ip6 = (struct ipv6hdr *)(skb->data + ETH_HLEN);
580 c_hdr = (u8 *)ip6 + sizeof(struct ipv6hdr);
585 switch (pkt_info & ipsec_pkt_types) {
586 case cpu_to_le16(IXGBE_RXDADV_PKTTYPE_IPSEC_AH):
587 spi = ((struct ip_auth_hdr *)c_hdr)->spi;
590 case cpu_to_le16(IXGBE_RXDADV_PKTTYPE_IPSEC_ESP):
591 spi = ((struct ip_esp_hdr *)c_hdr)->spi;
598 xs = ixgbevf_ipsec_find_rx_state(ipsec, daddr, proto, spi, !!ip4);
602 sp = secpath_set(skb);
606 sp->xvec[sp->len++] = xs;
608 xo = xfrm_offload(skb);
609 xo->flags = CRYPTO_DONE;
610 xo->status = CRYPTO_SUCCESS;
616 * ixgbevf_init_ipsec_offload - initialize registers for IPsec operation
617 * @adapter: board private structure
619 void ixgbevf_init_ipsec_offload(struct ixgbevf_adapter *adapter)
621 struct ixgbevf_ipsec *ipsec;
624 switch (adapter->hw.api_version) {
625 case ixgbe_mbox_api_14:
631 ipsec = kzalloc(sizeof(*ipsec), GFP_KERNEL);
634 hash_init(ipsec->rx_sa_list);
636 size = sizeof(struct rx_sa) * IXGBE_IPSEC_MAX_SA_COUNT;
637 ipsec->rx_tbl = kzalloc(size, GFP_KERNEL);
641 size = sizeof(struct tx_sa) * IXGBE_IPSEC_MAX_SA_COUNT;
642 ipsec->tx_tbl = kzalloc(size, GFP_KERNEL);
646 ipsec->num_rx_sa = 0;
647 ipsec->num_tx_sa = 0;
649 adapter->ipsec = ipsec;
651 adapter->netdev->xfrmdev_ops = &ixgbevf_xfrmdev_ops;
653 #define IXGBEVF_ESP_FEATURES (NETIF_F_HW_ESP | \
654 NETIF_F_HW_ESP_TX_CSUM | \
657 adapter->netdev->features |= IXGBEVF_ESP_FEATURES;
658 adapter->netdev->hw_enc_features |= IXGBEVF_ESP_FEATURES;
663 kfree(ipsec->rx_tbl);
664 kfree(ipsec->tx_tbl);
667 netdev_err(adapter->netdev, "Unable to allocate memory for SA tables");
671 * ixgbevf_stop_ipsec_offload - tear down the IPsec offload
672 * @adapter: board private structure
674 void ixgbevf_stop_ipsec_offload(struct ixgbevf_adapter *adapter)
676 struct ixgbevf_ipsec *ipsec = adapter->ipsec;
678 adapter->ipsec = NULL;
680 kfree(ipsec->rx_tbl);
681 kfree(ipsec->tx_tbl);