xref: /freebsd/sys/contrib/ncsw/Peripherals/FM/SP/fm_sp.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*
2  * Copyright 2008-2012 Freescale Semiconductor Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *     * Redistributions of source code must retain the above copyright
7  *       notice, this list of conditions and the following disclaimer.
8  *     * Redistributions in binary form must reproduce the above copyright
9  *       notice, this list of conditions and the following disclaimer in the
10  *       documentation and/or other materials provided with the distribution.
11  *     * Neither the name of Freescale Semiconductor nor the
12  *       names of its contributors may be used to endorse or promote products
13  *       derived from this software without specific prior written permission.
14  *
15  *
16  * ALTERNATIVELY, this software may be distributed under the terms of the
17  * GNU General Public License ("GPL") as published by the Free Software
18  * Foundation, either version 2 of that License or (at your option) any
19  * later version.
20  *
21  * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24  * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
25  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 
34 /******************************************************************************
35  @File          fm_sp.h
36 
37  @Description   FM SP  ...
38 *//***************************************************************************/
39 #ifndef __FM_SP_H
40 #define __FM_SP_H
41 
42 #include "std_ext.h"
43 #include "error_ext.h"
44 #include "list_ext.h"
45 
46 #include "fm_sp_common.h"
47 #include "fm_common.h"
48 
49 
50 #define __ERR_MODULE__  MODULE_FM_SP
51 
52 typedef struct {
53     t_FmBufferPrefixContent             bufferPrefixContent;
54     e_FmDmaSwapOption                   dmaSwapData;
55     e_FmDmaCacheOption                  dmaIntContextCacheAttr;
56     e_FmDmaCacheOption                  dmaHeaderCacheAttr;
57     e_FmDmaCacheOption                  dmaScatterGatherCacheAttr;
58     bool                                dmaWriteOptimize;
59     uint16_t                            liodnOffset;
60     bool                                noScatherGather;
61     t_FmBufPoolDepletion                *p_BufPoolDepletion;
62     t_FmBackupBmPools                   *p_BackupBmPools;
63     t_FmExtPools                        extBufPools;
64 } t_FmVspEntryDriverParams;
65 
66 typedef struct {
67     bool                        valid;
68     volatile bool               lock;
69     uint8_t                     pointedOwners;
70     uint16_t                    absoluteSpId;
71     uint8_t                     internalBufferOffset;
72     t_FmSpBufMargins            bufMargins;
73     t_FmSpIntContextDataCopy    intContext;
74     t_FmSpBufferOffsets         bufferOffsets;
75     t_Handle                    h_Fm;
76     e_FmPortType                portType;           /**< Port type */
77     uint8_t                     portId;             /**< Port Id - relative to type */
78     uint8_t                     relativeProfileId;
79     struct fm_pcd_storage_profile_regs *p_FmSpRegsBase;
80     t_FmExtPools                extBufPools;
81     t_FmVspEntryDriverParams    *p_FmVspEntryDriverParams;
82 } t_FmVspEntry;
83 
84 
85 #endif /* __FM_SP_H */
86