1*f05845fcSMahipal Challa /***********************license start************************************ 2*f05845fcSMahipal Challa * Copyright (c) 2003-2017 Cavium, Inc. 3*f05845fcSMahipal Challa * All rights reserved. 4*f05845fcSMahipal Challa * 5*f05845fcSMahipal Challa * License: one of 'Cavium License' or 'GNU General Public License Version 2' 6*f05845fcSMahipal Challa * 7*f05845fcSMahipal Challa * This file is provided under the terms of the Cavium License (see below) 8*f05845fcSMahipal Challa * or under the terms of GNU General Public License, Version 2, as 9*f05845fcSMahipal Challa * published by the Free Software Foundation. When using or redistributing 10*f05845fcSMahipal Challa * this file, you may do so under either license. 11*f05845fcSMahipal Challa * 12*f05845fcSMahipal Challa * Cavium License: Redistribution and use in source and binary forms, with 13*f05845fcSMahipal Challa * or without modification, are permitted provided that the following 14*f05845fcSMahipal Challa * conditions are met: 15*f05845fcSMahipal Challa * 16*f05845fcSMahipal Challa * * Redistributions of source code must retain the above copyright 17*f05845fcSMahipal Challa * notice, this list of conditions and the following disclaimer. 18*f05845fcSMahipal Challa * 19*f05845fcSMahipal Challa * * Redistributions in binary form must reproduce the above 20*f05845fcSMahipal Challa * copyright notice, this list of conditions and the following 21*f05845fcSMahipal Challa * disclaimer in the documentation and/or other materials provided 22*f05845fcSMahipal Challa * with the distribution. 23*f05845fcSMahipal Challa * 24*f05845fcSMahipal Challa * * Neither the name of Cavium Inc. nor the names of its contributors may be 25*f05845fcSMahipal Challa * used to endorse or promote products derived from this software without 26*f05845fcSMahipal Challa * specific prior written permission. 27*f05845fcSMahipal Challa * 28*f05845fcSMahipal Challa * This Software, including technical data, may be subject to U.S. export 29*f05845fcSMahipal Challa * control laws, including the U.S. Export Administration Act and its 30*f05845fcSMahipal Challa * associated regulations, and may be subject to export or import 31*f05845fcSMahipal Challa * regulations in other countries. 32*f05845fcSMahipal Challa * 33*f05845fcSMahipal Challa * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 34*f05845fcSMahipal Challa * AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS 35*f05845fcSMahipal Challa * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH 36*f05845fcSMahipal Challa * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY 37*f05845fcSMahipal Challa * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT 38*f05845fcSMahipal Challa * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) 39*f05845fcSMahipal Challa * WARRANTIES OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A 40*f05845fcSMahipal Challa * PARTICULAR PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET 41*f05845fcSMahipal Challa * ENJOYMENT, QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE 42*f05845fcSMahipal Challa * ENTIRE RISK ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES 43*f05845fcSMahipal Challa * WITH YOU. 44*f05845fcSMahipal Challa ***********************license end**************************************/ 45*f05845fcSMahipal Challa 46*f05845fcSMahipal Challa #include <linux/delay.h> 47*f05845fcSMahipal Challa #include <linux/sched.h> 48*f05845fcSMahipal Challa 49*f05845fcSMahipal Challa #include "common.h" 50*f05845fcSMahipal Challa #include "zip_deflate.h" 51*f05845fcSMahipal Challa 52*f05845fcSMahipal Challa /* Prepares the deflate zip command */ 53*f05845fcSMahipal Challa static int prepare_zip_command(struct zip_operation *zip_ops, 54*f05845fcSMahipal Challa struct zip_state *s, union zip_inst_s *zip_cmd) 55*f05845fcSMahipal Challa { 56*f05845fcSMahipal Challa union zip_zres_s *result_ptr = &s->result; 57*f05845fcSMahipal Challa 58*f05845fcSMahipal Challa memset(zip_cmd, 0, sizeof(s->zip_cmd)); 59*f05845fcSMahipal Challa memset(result_ptr, 0, sizeof(s->result)); 60*f05845fcSMahipal Challa 61*f05845fcSMahipal Challa /* IWORD #0 */ 62*f05845fcSMahipal Challa /* History gather */ 63*f05845fcSMahipal Challa zip_cmd->s.hg = 0; 64*f05845fcSMahipal Challa /* compression enable = 1 for deflate */ 65*f05845fcSMahipal Challa zip_cmd->s.ce = 1; 66*f05845fcSMahipal Challa /* sf (sync flush) */ 67*f05845fcSMahipal Challa zip_cmd->s.sf = 1; 68*f05845fcSMahipal Challa /* ef (end of file) */ 69*f05845fcSMahipal Challa if (zip_ops->flush == ZIP_FLUSH_FINISH) { 70*f05845fcSMahipal Challa zip_cmd->s.ef = 1; 71*f05845fcSMahipal Challa zip_cmd->s.sf = 0; 72*f05845fcSMahipal Challa } 73*f05845fcSMahipal Challa 74*f05845fcSMahipal Challa zip_cmd->s.cc = zip_ops->ccode; 75*f05845fcSMahipal Challa /* ss (compression speed/storage) */ 76*f05845fcSMahipal Challa zip_cmd->s.ss = zip_ops->speed; 77*f05845fcSMahipal Challa 78*f05845fcSMahipal Challa /* IWORD #1 */ 79*f05845fcSMahipal Challa /* adler checksum */ 80*f05845fcSMahipal Challa zip_cmd->s.adlercrc32 = zip_ops->csum; 81*f05845fcSMahipal Challa zip_cmd->s.historylength = zip_ops->history_len; 82*f05845fcSMahipal Challa zip_cmd->s.dg = 0; 83*f05845fcSMahipal Challa 84*f05845fcSMahipal Challa /* IWORD # 6 and 7 - compression input/history pointer */ 85*f05845fcSMahipal Challa zip_cmd->s.inp_ptr_addr.s.addr = __pa(zip_ops->input); 86*f05845fcSMahipal Challa zip_cmd->s.inp_ptr_ctl.s.length = (zip_ops->input_len + 87*f05845fcSMahipal Challa zip_ops->history_len); 88*f05845fcSMahipal Challa zip_cmd->s.ds = 0; 89*f05845fcSMahipal Challa 90*f05845fcSMahipal Challa /* IWORD # 8 and 9 - Output pointer */ 91*f05845fcSMahipal Challa zip_cmd->s.out_ptr_addr.s.addr = __pa(zip_ops->output); 92*f05845fcSMahipal Challa zip_cmd->s.out_ptr_ctl.s.length = zip_ops->output_len; 93*f05845fcSMahipal Challa /* maximum number of output-stream bytes that can be written */ 94*f05845fcSMahipal Challa zip_cmd->s.totaloutputlength = zip_ops->output_len; 95*f05845fcSMahipal Challa 96*f05845fcSMahipal Challa /* IWORD # 10 and 11 - Result pointer */ 97*f05845fcSMahipal Challa zip_cmd->s.res_ptr_addr.s.addr = __pa(result_ptr); 98*f05845fcSMahipal Challa /* Clearing completion code */ 99*f05845fcSMahipal Challa result_ptr->s.compcode = 0; 100*f05845fcSMahipal Challa 101*f05845fcSMahipal Challa return 0; 102*f05845fcSMahipal Challa } 103*f05845fcSMahipal Challa 104*f05845fcSMahipal Challa /** 105*f05845fcSMahipal Challa * zip_deflate - API to offload deflate operation to hardware 106*f05845fcSMahipal Challa * @zip_ops: Pointer to zip operation structure 107*f05845fcSMahipal Challa * @s: Pointer to the structure representing zip state 108*f05845fcSMahipal Challa * @zip_dev: Pointer to zip device structure 109*f05845fcSMahipal Challa * 110*f05845fcSMahipal Challa * This function prepares the zip deflate command and submits it to the zip 111*f05845fcSMahipal Challa * engine for processing. 112*f05845fcSMahipal Challa * 113*f05845fcSMahipal Challa * Return: 0 if successful or error code 114*f05845fcSMahipal Challa */ 115*f05845fcSMahipal Challa int zip_deflate(struct zip_operation *zip_ops, struct zip_state *s, 116*f05845fcSMahipal Challa struct zip_device *zip_dev) 117*f05845fcSMahipal Challa { 118*f05845fcSMahipal Challa union zip_inst_s *zip_cmd = &s->zip_cmd; 119*f05845fcSMahipal Challa union zip_zres_s *result_ptr = &s->result; 120*f05845fcSMahipal Challa u32 queue; 121*f05845fcSMahipal Challa 122*f05845fcSMahipal Challa /* Prepares zip command based on the input parameters */ 123*f05845fcSMahipal Challa prepare_zip_command(zip_ops, s, zip_cmd); 124*f05845fcSMahipal Challa 125*f05845fcSMahipal Challa /* Loads zip command into command queues and rings door bell */ 126*f05845fcSMahipal Challa queue = zip_load_instr(zip_cmd, zip_dev); 127*f05845fcSMahipal Challa 128*f05845fcSMahipal Challa while (!result_ptr->s.compcode) 129*f05845fcSMahipal Challa continue; 130*f05845fcSMahipal Challa 131*f05845fcSMahipal Challa zip_ops->compcode = result_ptr->s.compcode; 132*f05845fcSMahipal Challa switch (zip_ops->compcode) { 133*f05845fcSMahipal Challa case ZIP_CMD_NOTDONE: 134*f05845fcSMahipal Challa zip_dbg("Zip instruction not yet completed"); 135*f05845fcSMahipal Challa return ZIP_ERROR; 136*f05845fcSMahipal Challa 137*f05845fcSMahipal Challa case ZIP_CMD_SUCCESS: 138*f05845fcSMahipal Challa zip_dbg("Zip instruction completed successfully"); 139*f05845fcSMahipal Challa zip_update_cmd_bufs(zip_dev, queue); 140*f05845fcSMahipal Challa break; 141*f05845fcSMahipal Challa 142*f05845fcSMahipal Challa case ZIP_CMD_DTRUNC: 143*f05845fcSMahipal Challa zip_dbg("Output Truncate error"); 144*f05845fcSMahipal Challa /* Returning ZIP_ERROR to avoid copy to user */ 145*f05845fcSMahipal Challa return ZIP_ERROR; 146*f05845fcSMahipal Challa 147*f05845fcSMahipal Challa default: 148*f05845fcSMahipal Challa zip_err("Zip instruction failed. Code:%d", zip_ops->compcode); 149*f05845fcSMahipal Challa return ZIP_ERROR; 150*f05845fcSMahipal Challa } 151*f05845fcSMahipal Challa 152*f05845fcSMahipal Challa /* Update the CRC depending on the format */ 153*f05845fcSMahipal Challa switch (zip_ops->format) { 154*f05845fcSMahipal Challa case RAW_FORMAT: 155*f05845fcSMahipal Challa zip_dbg("RAW Format: %d ", zip_ops->format); 156*f05845fcSMahipal Challa /* Get checksum from engine, need to feed it again */ 157*f05845fcSMahipal Challa zip_ops->csum = result_ptr->s.adler32; 158*f05845fcSMahipal Challa break; 159*f05845fcSMahipal Challa 160*f05845fcSMahipal Challa case ZLIB_FORMAT: 161*f05845fcSMahipal Challa zip_dbg("ZLIB Format: %d ", zip_ops->format); 162*f05845fcSMahipal Challa zip_ops->csum = result_ptr->s.adler32; 163*f05845fcSMahipal Challa break; 164*f05845fcSMahipal Challa 165*f05845fcSMahipal Challa case GZIP_FORMAT: 166*f05845fcSMahipal Challa zip_dbg("GZIP Format: %d ", zip_ops->format); 167*f05845fcSMahipal Challa zip_ops->csum = result_ptr->s.crc32; 168*f05845fcSMahipal Challa break; 169*f05845fcSMahipal Challa 170*f05845fcSMahipal Challa case LZS_FORMAT: 171*f05845fcSMahipal Challa zip_dbg("LZS Format: %d ", zip_ops->format); 172*f05845fcSMahipal Challa break; 173*f05845fcSMahipal Challa 174*f05845fcSMahipal Challa default: 175*f05845fcSMahipal Challa zip_err("Unknown Format:%d\n", zip_ops->format); 176*f05845fcSMahipal Challa } 177*f05845fcSMahipal Challa 178*f05845fcSMahipal Challa /* Update output_len */ 179*f05845fcSMahipal Challa if (zip_ops->output_len < result_ptr->s.totalbyteswritten) { 180*f05845fcSMahipal Challa /* Dynamic stop && strm->output_len < zipconstants[onfsize] */ 181*f05845fcSMahipal Challa zip_err("output_len (%d) < total bytes written(%d)\n", 182*f05845fcSMahipal Challa zip_ops->output_len, result_ptr->s.totalbyteswritten); 183*f05845fcSMahipal Challa zip_ops->output_len = 0; 184*f05845fcSMahipal Challa 185*f05845fcSMahipal Challa } else { 186*f05845fcSMahipal Challa zip_ops->output_len = result_ptr->s.totalbyteswritten; 187*f05845fcSMahipal Challa } 188*f05845fcSMahipal Challa 189*f05845fcSMahipal Challa return 0; 190*f05845fcSMahipal Challa } 191