← Back to branch summary

~ubuntu-branches/ubuntu/trusty/grub2/trusty-updates

« back to all changes in this revision

Viewing changes to grub-core/lib/xzembed/xz_private.h

Tags: upstream-1.99~20101122
Import upstream version 1.99~20101122

Show diffs side-by-side

added added

removed removed

Lines of Context:
grub-core/lib/xzembed/xz_private.h
 
1
/* xz_private.h - Private includes and definitions */
 
2
/*
 
3
 *  GRUB  --  GRand Unified Bootloader
 
4
 *  Copyright (C) 2010  Free Software Foundation, Inc.
 
5
 *
 
6
 *  GRUB is free software: you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation, either version 3 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  GRUB is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 
18
 */
 
19
/*
 
20
 * This file is based on code from XZ embedded project
 
21
 * http://tukaani.org/xz/embedded.html
 
22
 */
 
23
 
 
24
#ifndef XZ_PRIVATE_H
 
25
#define XZ_PRIVATE_H
 
26
 
 
27
/*
 
28
 * For userspace builds, use a separate header to define the required
 
29
 * macros and functions. This makes it easier to adapt the code into
 
30
 * different environments and avoids clutter in the Linux kernel tree.
 
31
 */
 
32
#include "xz_config.h"
 
33
 
 
34
/*
 
35
 * If any of the BCJ filter decoders are wanted, define XZ_DEC_BCJ.
 
36
 * XZ_DEC_BCJ is used to enable generic support for BCJ decoders.
 
37
 */
 
38
#ifndef XZ_DEC_BCJ
 
39
#       if defined(XZ_DEC_X86) || defined(XZ_DEC_POWERPC) \
 
40
                        || defined(XZ_DEC_IA64) || defined(XZ_DEC_ARM) \
 
41
                        || defined(XZ_DEC_ARM) || defined(XZ_DEC_ARMTHUMB) \
 
42
                        || defined(XZ_DEC_SPARC)
 
43
#               define XZ_DEC_BCJ
 
44
#       endif
 
45
#endif
 
46
 
 
47
/*
 
48
 * Allocate memory for LZMA2 decoder. xz_dec_lzma2_reset() must be used
 
49
 * before calling xz_dec_lzma2_run().
 
50
 */
 
51
struct xz_dec_lzma2 * xz_dec_lzma2_create(
 
52
                uint32_t dict_max);
 
53
 
 
54
/*
 
55
 * Decode the LZMA2 properties (one byte) and reset the decoder. Return
 
56
 * XZ_OK on success, XZ_MEMLIMIT_ERROR if the preallocated dictionary is not
 
57
 * big enough, and XZ_OPTIONS_ERROR if props indicates something that this
 
58
 * decoder doesn't support.
 
59
 */
 
60
enum xz_ret xz_dec_lzma2_reset(
 
61
                struct xz_dec_lzma2 *s, uint8_t props);
 
62
 
 
63
/* Decode raw LZMA2 stream from b->in to b->out. */
 
64
enum xz_ret xz_dec_lzma2_run(
 
65
                struct xz_dec_lzma2 *s, struct xz_buf *b);
 
66
 
 
67
/* Free the memory allocated for the LZMA2 decoder. */
 
68
void xz_dec_lzma2_end(struct xz_dec_lzma2 *s);
 
69
 
 
70
/*
 
71
 * Allocate memory for BCJ decoders. xz_dec_bcj_reset() must be used before
 
72
 * calling xz_dec_bcj_run().
 
73
 */
 
74
struct xz_dec_bcj * xz_dec_bcj_create(bool single_call);
 
75
 
 
76
/*
 
77
 * Decode the Filter ID of a BCJ filter. This implementation doesn't
 
78
 * support custom start offsets, so no decoding of Filter Properties
 
79
 * is needed. Returns XZ_OK if the given Filter ID is supported.
 
80
 * Otherwise XZ_OPTIONS_ERROR is returned.
 
81
 */
 
82
enum xz_ret xz_dec_bcj_reset(
 
83
                struct xz_dec_bcj *s, uint8_t id);
 
84
 
 
85
/*
 
86
 * Decode raw BCJ + LZMA2 stream. This must be used only if there actually is
 
87
 * a BCJ filter in the chain. If the chain has only LZMA2, xz_dec_lzma2_run()
 
88
 * must be called directly.
 
89
 */
 
90
enum xz_ret xz_dec_bcj_run(struct xz_dec_bcj *s,
 
91
                struct xz_dec_lzma2 *lzma2, struct xz_buf *b);
 
92
 
 
93
/* Free the memory allocated for the BCJ filters. */
 
94
#define xz_dec_bcj_end(s) kfree(s)
 
95
 
 
96
#endif