Dan Streetman | 7011a12 | 2015-05-07 13:49:17 -0400 | [diff] [blame] | 1 | |
| 2 | #ifndef __NX_842_H__ |
| 3 | #define __NX_842_H__ |
| 4 | |
| 5 | #include <linux/kernel.h> |
| 6 | #include <linux/module.h> |
| 7 | #include <linux/nx842.h> |
Dan Streetman | 99182a42 | 2015-05-07 13:49:19 -0400 | [diff] [blame^] | 8 | #include <linux/sw842.h> |
Dan Streetman | 7011a12 | 2015-05-07 13:49:17 -0400 | [diff] [blame] | 9 | #include <linux/of.h> |
| 10 | #include <linux/slab.h> |
| 11 | #include <linux/io.h> |
Dan Streetman | 99182a42 | 2015-05-07 13:49:19 -0400 | [diff] [blame^] | 12 | #include <linux/mm.h> |
| 13 | #include <linux/ratelimit.h> |
| 14 | |
| 15 | /* Restrictions on Data Descriptor List (DDL) and Entry (DDE) buffers |
| 16 | * |
| 17 | * From NX P8 workbook, sec 4.9.1 "842 details" |
| 18 | * Each DDE buffer is 128 byte aligned |
| 19 | * Each DDE buffer size is a multiple of 32 bytes (except the last) |
| 20 | * The last DDE buffer size is a multiple of 8 bytes |
| 21 | */ |
| 22 | #define DDE_BUFFER_ALIGN (128) |
| 23 | #define DDE_BUFFER_SIZE_MULT (32) |
| 24 | #define DDE_BUFFER_LAST_MULT (8) |
| 25 | |
| 26 | /* Arbitrary DDL length limit |
| 27 | * Allows max buffer size of MAX-1 to MAX pages |
| 28 | * (depending on alignment) |
| 29 | */ |
| 30 | #define DDL_LEN_MAX (17) |
| 31 | |
| 32 | /* CCW 842 CI/FC masks |
| 33 | * NX P8 workbook, section 4.3.1, figure 4-6 |
| 34 | * "CI/FC Boundary by NX CT type" |
| 35 | */ |
| 36 | #define CCW_CI_842 (0x00003ff8) |
| 37 | #define CCW_FC_842 (0x00000007) |
| 38 | |
| 39 | /* CCW Function Codes (FC) for 842 |
| 40 | * NX P8 workbook, section 4.9, table 4-28 |
| 41 | * "Function Code Definitions for 842 Memory Compression" |
| 42 | */ |
| 43 | #define CCW_FC_842_COMP_NOCRC (0) |
| 44 | #define CCW_FC_842_COMP_CRC (1) |
| 45 | #define CCW_FC_842_DECOMP_NOCRC (2) |
| 46 | #define CCW_FC_842_DECOMP_CRC (3) |
| 47 | #define CCW_FC_842_MOVE (4) |
| 48 | |
| 49 | /* CSB CC Error Types for 842 |
| 50 | * NX P8 workbook, section 4.10.3, table 4-30 |
| 51 | * "Reported Error Types Summary Table" |
| 52 | */ |
| 53 | /* These are all duplicates of existing codes defined in icswx.h. */ |
| 54 | #define CSB_CC_TRANSLATION_DUP1 (80) |
| 55 | #define CSB_CC_TRANSLATION_DUP2 (82) |
| 56 | #define CSB_CC_TRANSLATION_DUP3 (84) |
| 57 | #define CSB_CC_TRANSLATION_DUP4 (86) |
| 58 | #define CSB_CC_TRANSLATION_DUP5 (92) |
| 59 | #define CSB_CC_TRANSLATION_DUP6 (94) |
| 60 | #define CSB_CC_PROTECTION_DUP1 (81) |
| 61 | #define CSB_CC_PROTECTION_DUP2 (83) |
| 62 | #define CSB_CC_PROTECTION_DUP3 (85) |
| 63 | #define CSB_CC_PROTECTION_DUP4 (87) |
| 64 | #define CSB_CC_PROTECTION_DUP5 (93) |
| 65 | #define CSB_CC_PROTECTION_DUP6 (95) |
| 66 | #define CSB_CC_RD_EXTERNAL_DUP1 (89) |
| 67 | #define CSB_CC_RD_EXTERNAL_DUP2 (90) |
| 68 | #define CSB_CC_RD_EXTERNAL_DUP3 (91) |
| 69 | /* These are specific to NX */ |
| 70 | /* 842 codes */ |
| 71 | #define CSB_CC_TPBC_GT_SPBC (64) /* no error, but >1 comp ratio */ |
| 72 | #define CSB_CC_CRC_MISMATCH (65) /* decomp crc mismatch */ |
| 73 | #define CSB_CC_TEMPL_INVALID (66) /* decomp invalid template value */ |
| 74 | #define CSB_CC_TEMPL_OVERFLOW (67) /* decomp template shows data after end */ |
| 75 | /* sym crypt codes */ |
| 76 | #define CSB_CC_DECRYPT_OVERFLOW (64) |
| 77 | /* asym crypt codes */ |
| 78 | #define CSB_CC_MINV_OVERFLOW (128) |
| 79 | /* These are reserved for hypervisor use */ |
| 80 | #define CSB_CC_HYP_RESERVE_START (240) |
| 81 | #define CSB_CC_HYP_RESERVE_END (253) |
| 82 | #define CSB_CC_HYP_NO_HW (254) |
| 83 | #define CSB_CC_HYP_HANG_ABORTED (255) |
| 84 | |
| 85 | /* CCB Completion Modes (CM) for 842 |
| 86 | * NX P8 workbook, section 4.3, figure 4-5 |
| 87 | * "CRB Details - Normal Cop_Req (CL=00, C=1)" |
| 88 | */ |
| 89 | #define CCB_CM_EXTRA_WRITE (CCB_CM0_ALL_COMPLETIONS & CCB_CM12_STORE) |
| 90 | #define CCB_CM_INTERRUPT (CCB_CM0_ALL_COMPLETIONS & CCB_CM12_INTERRUPT) |
| 91 | |
| 92 | #define LEN_ON_PAGE(pa) (PAGE_SIZE - ((pa) & ~PAGE_MASK)) |
| 93 | |
| 94 | static inline unsigned long nx842_get_pa(void *addr) |
| 95 | { |
| 96 | if (!is_vmalloc_addr(addr)) |
| 97 | return __pa(addr); |
| 98 | |
| 99 | return page_to_phys(vmalloc_to_page(addr)) + offset_in_page(addr); |
| 100 | } |
| 101 | |
| 102 | /* Get/Set bit fields */ |
| 103 | #define MASK_LSH(m) (__builtin_ffsl(m) - 1) |
| 104 | #define GET_FIELD(v, m) (((v) & (m)) >> MASK_LSH(m)) |
| 105 | #define SET_FIELD(v, m, val) (((v) & ~(m)) | (((val) << MASK_LSH(m)) & (m))) |
Dan Streetman | 7011a12 | 2015-05-07 13:49:17 -0400 | [diff] [blame] | 106 | |
| 107 | struct nx842_driver { |
| 108 | struct module *owner; |
| 109 | |
Dan Streetman | 959e665 | 2015-05-07 13:49:18 -0400 | [diff] [blame] | 110 | struct nx842_constraints *constraints; |
| 111 | |
Dan Streetman | 7011a12 | 2015-05-07 13:49:17 -0400 | [diff] [blame] | 112 | int (*compress)(const unsigned char *in, unsigned int in_len, |
| 113 | unsigned char *out, unsigned int *out_len, |
| 114 | void *wrkmem); |
| 115 | int (*decompress)(const unsigned char *in, unsigned int in_len, |
| 116 | unsigned char *out, unsigned int *out_len, |
| 117 | void *wrkmem); |
| 118 | }; |
| 119 | |
| 120 | void nx842_register_driver(struct nx842_driver *driver); |
| 121 | void nx842_unregister_driver(struct nx842_driver *driver); |
| 122 | |
| 123 | |
| 124 | /* To allow the main nx-compress module to load platform module */ |
Dan Streetman | 99182a42 | 2015-05-07 13:49:19 -0400 | [diff] [blame^] | 125 | #define NX842_POWERNV_MODULE_NAME "nx-compress-powernv" |
| 126 | #define NX842_POWERNV_COMPAT_NAME "ibm,power-nx" |
Dan Streetman | 7011a12 | 2015-05-07 13:49:17 -0400 | [diff] [blame] | 127 | #define NX842_PSERIES_MODULE_NAME "nx-compress-pseries" |
| 128 | #define NX842_PSERIES_COMPAT_NAME "ibm,compression" |
| 129 | |
| 130 | |
| 131 | #endif /* __NX_842_H__ */ |