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