1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
27011a122SDan Streetman
37011a122SDan Streetman #ifndef __NX_842_H__
47011a122SDan Streetman #define __NX_842_H__
57011a122SDan Streetman
6*14386d47SHerbert Xu #include <crypto/algapi.h>
77011a122SDan Streetman #include <linux/kernel.h>
803952d98SDan Streetman #include <linux/init.h>
97011a122SDan Streetman #include <linux/module.h>
107011a122SDan Streetman #include <linux/of.h>
117011a122SDan Streetman #include <linux/slab.h>
127011a122SDan Streetman #include <linux/io.h>
1399182a42SDan Streetman #include <linux/mm.h>
1499182a42SDan Streetman #include <linux/ratelimit.h>
1599182a42SDan Streetman
1699182a42SDan Streetman /* Restrictions on Data Descriptor List (DDL) and Entry (DDE) buffers
1799182a42SDan Streetman *
1899182a42SDan Streetman * From NX P8 workbook, sec 4.9.1 "842 details"
1999182a42SDan Streetman * Each DDE buffer is 128 byte aligned
2099182a42SDan Streetman * Each DDE buffer size is a multiple of 32 bytes (except the last)
2199182a42SDan Streetman * The last DDE buffer size is a multiple of 8 bytes
2299182a42SDan Streetman */
2399182a42SDan Streetman #define DDE_BUFFER_ALIGN (128)
2499182a42SDan Streetman #define DDE_BUFFER_SIZE_MULT (32)
2599182a42SDan Streetman #define DDE_BUFFER_LAST_MULT (8)
2699182a42SDan Streetman
2799182a42SDan Streetman /* Arbitrary DDL length limit
2899182a42SDan Streetman * Allows max buffer size of MAX-1 to MAX pages
2999182a42SDan Streetman * (depending on alignment)
3099182a42SDan Streetman */
3199182a42SDan Streetman #define DDL_LEN_MAX (17)
3299182a42SDan Streetman
3399182a42SDan Streetman /* CCW 842 CI/FC masks
3499182a42SDan Streetman * NX P8 workbook, section 4.3.1, figure 4-6
3599182a42SDan Streetman * "CI/FC Boundary by NX CT type"
3699182a42SDan Streetman */
3799182a42SDan Streetman #define CCW_CI_842 (0x00003ff8)
3899182a42SDan Streetman #define CCW_FC_842 (0x00000007)
3999182a42SDan Streetman
4099182a42SDan Streetman /* CCW Function Codes (FC) for 842
4199182a42SDan Streetman * NX P8 workbook, section 4.9, table 4-28
4299182a42SDan Streetman * "Function Code Definitions for 842 Memory Compression"
4399182a42SDan Streetman */
4499182a42SDan Streetman #define CCW_FC_842_COMP_NOCRC (0)
4599182a42SDan Streetman #define CCW_FC_842_COMP_CRC (1)
4699182a42SDan Streetman #define CCW_FC_842_DECOMP_NOCRC (2)
4799182a42SDan Streetman #define CCW_FC_842_DECOMP_CRC (3)
4899182a42SDan Streetman #define CCW_FC_842_MOVE (4)
4999182a42SDan Streetman
5099182a42SDan Streetman /* CSB CC Error Types for 842
5199182a42SDan Streetman * NX P8 workbook, section 4.10.3, table 4-30
5299182a42SDan Streetman * "Reported Error Types Summary Table"
5399182a42SDan Streetman */
5499182a42SDan Streetman /* These are all duplicates of existing codes defined in icswx.h. */
5599182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP1 (80)
5699182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP2 (82)
5799182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP3 (84)
5899182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP4 (86)
5999182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP5 (92)
6099182a42SDan Streetman #define CSB_CC_TRANSLATION_DUP6 (94)
6199182a42SDan Streetman #define CSB_CC_PROTECTION_DUP1 (81)
6299182a42SDan Streetman #define CSB_CC_PROTECTION_DUP2 (83)
6399182a42SDan Streetman #define CSB_CC_PROTECTION_DUP3 (85)
6499182a42SDan Streetman #define CSB_CC_PROTECTION_DUP4 (87)
6599182a42SDan Streetman #define CSB_CC_PROTECTION_DUP5 (93)
6699182a42SDan Streetman #define CSB_CC_PROTECTION_DUP6 (95)
6799182a42SDan Streetman #define CSB_CC_RD_EXTERNAL_DUP1 (89)
6899182a42SDan Streetman #define CSB_CC_RD_EXTERNAL_DUP2 (90)
6999182a42SDan Streetman #define CSB_CC_RD_EXTERNAL_DUP3 (91)
7099182a42SDan Streetman /* These are specific to NX */
7199182a42SDan Streetman /* 842 codes */
7299182a42SDan Streetman #define CSB_CC_TPBC_GT_SPBC (64) /* no error, but >1 comp ratio */
7399182a42SDan Streetman #define CSB_CC_CRC_MISMATCH (65) /* decomp crc mismatch */
7499182a42SDan Streetman #define CSB_CC_TEMPL_INVALID (66) /* decomp invalid template value */
7599182a42SDan Streetman #define CSB_CC_TEMPL_OVERFLOW (67) /* decomp template shows data after end */
7699182a42SDan Streetman /* sym crypt codes */
7799182a42SDan Streetman #define CSB_CC_DECRYPT_OVERFLOW (64)
7899182a42SDan Streetman /* asym crypt codes */
7999182a42SDan Streetman #define CSB_CC_MINV_OVERFLOW (128)
80146e9f1bSHaren Myneni /*
81146e9f1bSHaren Myneni * HW error - Job did not finish in the maximum time allowed.
82146e9f1bSHaren Myneni * Job terminated.
83146e9f1bSHaren Myneni */
84146e9f1bSHaren Myneni #define CSB_CC_HW_EXPIRED_TIMER (224)
8599182a42SDan Streetman /* These are reserved for hypervisor use */
8699182a42SDan Streetman #define CSB_CC_HYP_RESERVE_START (240)
8799182a42SDan Streetman #define CSB_CC_HYP_RESERVE_END (253)
88146e9f1bSHaren Myneni #define CSB_CC_HYP_RESERVE_P9_END (251)
89146e9f1bSHaren Myneni /* No valid interrupt server (P9 or later). */
90146e9f1bSHaren Myneni #define CSB_CC_HYP_RESERVE_NO_INTR_SERVER (252)
9199182a42SDan Streetman #define CSB_CC_HYP_NO_HW (254)
9299182a42SDan Streetman #define CSB_CC_HYP_HANG_ABORTED (255)
9399182a42SDan Streetman
9499182a42SDan Streetman /* CCB Completion Modes (CM) for 842
9599182a42SDan Streetman * NX P8 workbook, section 4.3, figure 4-5
9699182a42SDan Streetman * "CRB Details - Normal Cop_Req (CL=00, C=1)"
9799182a42SDan Streetman */
9899182a42SDan Streetman #define CCB_CM_EXTRA_WRITE (CCB_CM0_ALL_COMPLETIONS & CCB_CM12_STORE)
9999182a42SDan Streetman #define CCB_CM_INTERRUPT (CCB_CM0_ALL_COMPLETIONS & CCB_CM12_INTERRUPT)
10099182a42SDan Streetman
101c47d6302SDan Streetman #define LEN_ON_SIZE(pa, size) ((size) - ((pa) & ((size) - 1)))
102c47d6302SDan Streetman #define LEN_ON_PAGE(pa) LEN_ON_SIZE(pa, PAGE_SIZE)
10399182a42SDan Streetman
nx842_get_pa(void * addr)10499182a42SDan Streetman static inline unsigned long nx842_get_pa(void *addr)
10599182a42SDan Streetman {
10699182a42SDan Streetman if (!is_vmalloc_addr(addr))
10799182a42SDan Streetman return __pa(addr);
10899182a42SDan Streetman
10999182a42SDan Streetman return page_to_phys(vmalloc_to_page(addr)) + offset_in_page(addr);
11099182a42SDan Streetman }
11199182a42SDan Streetman
112d31581a6SDan Streetman /**
113d31581a6SDan Streetman * This provides the driver's constraints. Different nx842 implementations
114d31581a6SDan Streetman * may have varying requirements. The constraints are:
115d31581a6SDan Streetman * @alignment: All buffers should be aligned to this
116d31581a6SDan Streetman * @multiple: All buffer lengths should be a multiple of this
117d31581a6SDan Streetman * @minimum: Buffer lengths must not be less than this amount
118d31581a6SDan Streetman * @maximum: Buffer lengths must not be more than this amount
119d31581a6SDan Streetman *
120d31581a6SDan Streetman * The constraints apply to all buffers and lengths, both input and output,
121d31581a6SDan Streetman * for both compression and decompression, except for the minimum which
122d31581a6SDan Streetman * only applies to compression input and decompression output; the
123d31581a6SDan Streetman * compressed data can be less than the minimum constraint. It can be
124d31581a6SDan Streetman * assumed that compressed data will always adhere to the multiple
125d31581a6SDan Streetman * constraint.
126d31581a6SDan Streetman *
127d31581a6SDan Streetman * The driver may succeed even if these constraints are violated;
128d31581a6SDan Streetman * however the driver can return failure or suffer reduced performance
129d31581a6SDan Streetman * if any constraint is not met.
130d31581a6SDan Streetman */
13132be6d3eSDan Streetman struct nx842_constraints {
13232be6d3eSDan Streetman int alignment;
13332be6d3eSDan Streetman int multiple;
13432be6d3eSDan Streetman int minimum;
13532be6d3eSDan Streetman int maximum;
13632be6d3eSDan Streetman };
13732be6d3eSDan Streetman
1387011a122SDan Streetman struct nx842_driver {
1393e648cbeSDan Streetman char *name;
1407011a122SDan Streetman struct module *owner;
1412c6f6eabSDan Streetman size_t workmem_size;
1427011a122SDan Streetman
143959e6659SDan Streetman struct nx842_constraints *constraints;
144959e6659SDan Streetman
1457011a122SDan Streetman int (*compress)(const unsigned char *in, unsigned int in_len,
1467011a122SDan Streetman unsigned char *out, unsigned int *out_len,
1477011a122SDan Streetman void *wrkmem);
1487011a122SDan Streetman int (*decompress)(const unsigned char *in, unsigned int in_len,
1497011a122SDan Streetman unsigned char *out, unsigned int *out_len,
1507011a122SDan Streetman void *wrkmem);
1517011a122SDan Streetman };
1527011a122SDan Streetman
15303952d98SDan Streetman struct nx842_crypto_header_group {
15403952d98SDan Streetman __be16 padding; /* unused bytes at start of group */
15503952d98SDan Streetman __be32 compressed_length; /* compressed bytes in group */
15603952d98SDan Streetman __be32 uncompressed_length; /* bytes after decompression */
15703952d98SDan Streetman } __packed;
15803952d98SDan Streetman
15903952d98SDan Streetman struct nx842_crypto_header {
16003952d98SDan Streetman __be16 magic; /* NX842_CRYPTO_MAGIC */
16103952d98SDan Streetman __be16 ignore; /* decompressed end bytes to ignore */
16203952d98SDan Streetman u8 groups; /* total groups in this header */
16303952d98SDan Streetman struct nx842_crypto_header_group group[];
16403952d98SDan Streetman } __packed;
16503952d98SDan Streetman
16603952d98SDan Streetman #define NX842_CRYPTO_GROUP_MAX (0x20)
16703952d98SDan Streetman
16803952d98SDan Streetman struct nx842_crypto_ctx {
16903952d98SDan Streetman spinlock_t lock;
17003952d98SDan Streetman
17103952d98SDan Streetman u8 *wmem;
17203952d98SDan Streetman u8 *sbounce, *dbounce;
17303952d98SDan Streetman
17403952d98SDan Streetman struct nx842_crypto_header header;
17503952d98SDan Streetman struct nx842_crypto_header_group group[NX842_CRYPTO_GROUP_MAX];
17603952d98SDan Streetman
17703952d98SDan Streetman struct nx842_driver *driver;
17803952d98SDan Streetman };
17903952d98SDan Streetman
18003952d98SDan Streetman int nx842_crypto_init(struct crypto_tfm *tfm, struct nx842_driver *driver);
18103952d98SDan Streetman void nx842_crypto_exit(struct crypto_tfm *tfm);
18203952d98SDan Streetman int nx842_crypto_compress(struct crypto_tfm *tfm,
18303952d98SDan Streetman const u8 *src, unsigned int slen,
18403952d98SDan Streetman u8 *dst, unsigned int *dlen);
18503952d98SDan Streetman int nx842_crypto_decompress(struct crypto_tfm *tfm,
18603952d98SDan Streetman const u8 *src, unsigned int slen,
18703952d98SDan Streetman u8 *dst, unsigned int *dlen);
1887011a122SDan Streetman
1897011a122SDan Streetman #endif /* __NX_842_H__ */
190