xref: /openbmc/linux/drivers/crypto/cavium/zip/zip_inflate.h (revision a976c2951d8f376112361830aa7762beff83a205)
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 #ifndef __ZIP_INFLATE_H__
47*f05845fcSMahipal Challa #define __ZIP_INFLATE_H__
48*f05845fcSMahipal Challa 
49*f05845fcSMahipal Challa /**
50*f05845fcSMahipal Challa  * zip_inflate - API to offload inflate operation to hardware
51*f05845fcSMahipal Challa  * @zip_ops: Pointer to zip operation structure
52*f05845fcSMahipal Challa  * @s:       Pointer to the structure representing zip state
53*f05845fcSMahipal Challa  * @zip_dev: Pointer to the structure representing zip device
54*f05845fcSMahipal Challa  *
55*f05845fcSMahipal Challa  * This function prepares the zip inflate command and submits it to the zip
56*f05845fcSMahipal Challa  * engine for processing.
57*f05845fcSMahipal Challa  *
58*f05845fcSMahipal Challa  * Return: 0 if successful or error code
59*f05845fcSMahipal Challa  */
60*f05845fcSMahipal Challa int zip_inflate(struct zip_operation *zip_ops, struct zip_state *s,
61*f05845fcSMahipal Challa 		struct zip_device *zip_dev);
62*f05845fcSMahipal Challa #endif
63