summaryrefslogtreecommitdiff
path: root/Acceleration/drivers/icp_tdm/tdm_setup_driver/include/tdm_setup_drv_p.h
blob: b3b7b7849d2c4500607c3c3dd09b827e7e24b554 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/**************************************************************************
 * @file tdm_setup_drv_p.h
 *
 * @description
 *      This file contains the TDM Setup Driver private declarations
 *
 * @par
 * This file is provided under a dual BSD/GPLv2 license.  When using or 
 *   redistributing this file, you may do so under either license.
 * 
 *   GPL LICENSE SUMMARY
 * 
 *   Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
 *   Copyright(c) 2010,2011,2012 Avencall
 * 
 *   This program is free software; you can redistribute it and/or modify 
 *   it under the terms of version 2 of the GNU General Public License as
 *   published by the Free Software Foundation.
 * 
 *   This program is distributed in the hope that it will be useful, but 
 *   WITHOUT ANY WARRANTY; without even the implied warranty of 
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
 *   General Public License for more details.
 * 
 *   You should have received a copy of the GNU General Public License 
 *   along with this program; if not, write to the Free Software 
 *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *   The full GNU General Public License is included in this distribution 
 *   in the file called LICENSE.GPL.
 * 
 *   BSD LICENSE 
 * 
 *   Copyright(c) 2007,2008,2009 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *   Copyright(c) 2010,2011,2012 Avencall
 * 
 *   Redistribution and use in source and binary forms, with or without 
 *   modification, are permitted provided that the following conditions 
 *   are met:
 * 
 *     * Redistributions of source code must retain the above copyright 
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in 
 *       the documentation and/or other materials provided with the 
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its 
 *       contributors may be used to endorse or promote products derived 
 *       from this software without specific prior written permission.
 * 
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * 
 *
 *
 **************************************************************************/
#ifndef TDM_SETUP_DRV_P_H_
#define TDM_SETUP_DRV_P_H_

/**********************************
 * DEFINES
 *********************************/
#define PCI_DEVICE_TDM_UNIT    0x504C   /*TDM Unit PCI Device ID */

#define MAX_PCI_BARS       6    /*Max No. of BARS for any device */
#define TDM_UNIT_BARS      2    /*total No. of TDM unit BARS */

#define TDM_UNIT_CSR_BAR   0
#define TDM_UNIT_CCP_BAR   1

/*These are the three types of interrupts that can be generated by the TDM
 * IO Unit that have to be handled by this driver.
 * FUNCTIONAL INTERRUPT:
 * signals that the TDM IO Unit has responsed to a message sent down by the
 * piuMh component.
 * TRIGGER INTERRUPT:
 * used to notify TDM IO Access Layer that packets are ready for processing
 * ERROR INTERRUPT:
 * reports a parity error in TDM IO Unit memory.
 * There is no recovery from this situation*/
#define PCI_SMIA_REG_OFFSET       0xE8
#define PCI_INT_TARGET_REG_OFFSET 0xEC

#define TDM_INT_FUNCTIONAL   0x01
#define TDM_INT_ERROR        0x02
#define TDM_INT_TRIGGER      0x04

/*the total number of minor numbers required
 * when registering the driver*/
#define MINOR_NUMS_REQ 1

#define TDM_SETUP_DEVICE(device_id) \
{ \
PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}

#define AUTO_INIT_ENABLED 1
#define AUTO_INIT_DISABLED 0

/*The number of mezzanine slots supported*/
#define TDM_MAX_MEZZ_SLOTS 3

/*Debug tracing*/
#ifdef DEBUG
#define  TDM_SETUP_DEBUG   printk
#else
#define NULL_TDM_SETUP_DEBUG(x, y...)
#define  TDM_SETUP_DEBUG   NULL_TDM_SETUP_DEBUG
#endif

/**********************************
 * TYPE DEFINITIONS
 *********************************/
/*BAR information*/
struct _tdm_bar_s {

        uint64_t base_addr;     /* read from PCI config */

        uint64_t virt_addr;     /* mapped to kernel VA */

        uint32_t size;          /* size of BAR */

};

/*
 * PCI information
 */
struct tdm_pci_info_s {

        struct pci_dev *pdev;

        uint32_t device_id;

        uint32_t irq;

        uint32_t num_bars;

        struct _tdm_bar_s pci_bars[MAX_PCI_BARS];

};

struct tdm_dev_s {

        struct tdm_pci_info_s device;   /* PCI Device */

        /* Linked list of device_handles */
        struct tdm_dev_s *pnext;

        struct tdm_dev_s *pprev;

};

#endif                          /*TDM_SETUP_DRV_P_H_ */