summaryrefslogtreecommitdiff
path: root/bsp/lm3s9b9x/libraries/driverlib/fan.h
blob: b9ec10e31f6a8fd8ad7b378423ebb8e16d2024dd (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
163
164
165
166
167
168
//*****************************************************************************
//
// fan.h - Prototypes and macros for the Fan controller.
//
// Copyright (c) 2010-2011 Texas Instruments Incorporated.  All rights reserved.
// Software License Agreement
// 
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
// 
// This is part of revision 8264 of the Stellaris Peripheral Driver Library.
//
//*****************************************************************************

#ifndef __FAN_H__
#define __FAN_H__

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

//*****************************************************************************
//
// Fan status values that can be returned from the FanChannelStatus() function.
//
//*****************************************************************************
#define FAN_STATUS_STALLED          0
#define FAN_STATUS_CHANGING         1
#define FAN_STATUS_LOCKED           2
#define FAN_STATUS_NOATTAIN         3

//*****************************************************************************
//
// Configuration flags to be used with FanChannelConfigManual() and
// FanChannelConfigAuto().
//
//*****************************************************************************
#define FAN_CONFIG_RESTART          (1 << 15)
#define FAN_CONFIG_NORESTART        (0 << 15)
#define FAN_CONFIG_ACCEL_FAST       (1 << 14)
#define FAN_CONFIG_ACCEL_SLOW       (0 << 14)
#define FAN_CONFIG_HYST_1           (0 << 11)
#define FAN_CONFIG_HYST_2           (1 << 11)
#define FAN_CONFIG_HYST_4           (2 << 11)
#define FAN_CONFIG_HYST_8           (3 << 11)
#define FAN_CONFIG_HYST_16          (4 << 11)
#define FAN_CONFIG_HYST_32          (5 << 11)
#define FAN_CONFIG_HYST_64          (6 << 11)
#define FAN_CONFIG_HYST_128         (7 << 11)
#define FAN_CONFIG_START_2          (0 << 8)
#define FAN_CONFIG_START_4          (1 << 8)
#define FAN_CONFIG_START_8          (2 << 8)
#define FAN_CONFIG_START_16         (3 << 8)
#define FAN_CONFIG_START_32         (4 << 8)
#define FAN_CONFIG_START_64         (5 << 8)
#define FAN_CONFIG_START_128        (6 << 8)
#define FAN_CONFIG_START_256        (7 << 8)
#define FAN_CONFIG_START_DUTY_OFF   (0 << 6)
#define FAN_CONFIG_START_DUTY_50    (1 << 6)
#define FAN_CONFIG_START_DUTY_75    (2 << 6)
#define FAN_CONFIG_START_DUTY_100   (3 << 6)
#define FAN_CONFIG_AVG_NONE         (0 << 4)
#define FAN_CONFIG_AVG_2            (1 << 4)
#define FAN_CONFIG_AVG_4            (2 << 4)
#define FAN_CONFIG_AVG_8            (3 << 4)
#define FAN_CONFIG_TACH_1           (0 << 2)
#define FAN_CONFIG_TACH_2           (1 << 2)
#define FAN_CONFIG_TACH_4           (2 << 2)
#define FAN_CONFIG_TACH_8           (3 << 2)

//*****************************************************************************
//
// Interrupt configuration/status flags to be used with the following
// functions: FanIntEnable(), FanIntDisable(), FanIntStatus(), FanIntClear().
//
//*****************************************************************************
#define FAN_CH5_INT_AUTO_SPEED_OK       (1 << 22)
#define FAN_CH5_INT_MANUAL_SPEED_CHANGE (1 << 22)
#define FAN_CH5_INT_AUTO_SPEED_ERROR    (1 << 21)
#define FAN_CH5_INT_MANUAL_SPEED_UPDATE (1 << 21)
#define FAN_CH5_INT_STALL               (1 << 20)
#define FAN_CH4_INT_AUTO_SPEED_OK       (1 << 18)
#define FAN_CH4_INT_MANUAL_SPEED_CHANGE (1 << 18)
#define FAN_CH4_INT_AUTO_SPEED_ERROR    (1 << 17)
#define FAN_CH4_INT_MANUAL_SPEED_UPDATE (1 << 17)
#define FAN_CH4_INT_STALL               (1 << 16)
#define FAN_CH3_INT_AUTO_SPEED_OK       (1 << 14)
#define FAN_CH3_INT_MANUAL_SPEED_CHANGE (1 << 14)
#define FAN_CH3_INT_AUTO_SPEED_ERROR    (1 << 13)
#define FAN_CH3_INT_MANUAL_SPEED_UPDATE (1 << 13)
#define FAN_CH3_INT_STALL               (1 << 12)
#define FAN_CH2_INT_AUTO_SPEED_OK       (1 << 10)
#define FAN_CH2_INT_MANUAL_SPEED_CHANGE (1 << 10)
#define FAN_CH2_INT_AUTO_SPEED_ERROR    (1 << 9)
#define FAN_CH2_INT_MANUAL_SPEED_UPDATE (1 << 9)
#define FAN_CH2_INT_STALL               (1 << 8)
#define FAN_CH1_INT_AUTO_SPEED_OK       (1 << 6)
#define FAN_CH1_INT_MANUAL_SPEED_CHANGE (1 << 6)
#define FAN_CH1_INT_AUTO_SPEED_ERROR    (1 << 5)
#define FAN_CH1_INT_MANUAL_SPEED_UPDATE (1 << 5)
#define FAN_CH1_INT_STALL               (1 << 4)
#define FAN_CH0_INT_AUTO_SPEED_OK       (1 << 2)
#define FAN_CH0_INT_MANUAL_SPEED_CHANGE (1 << 2)
#define FAN_CH0_INT_AUTO_SPEED_ERROR    (1 << 1)
#define FAN_CH0_INT_MANUAL_SPEED_UPDATE (1 << 1)
#define FAN_CH0_INT_STALL               (1 << 0)
#define FAN_CHx_INT_AUTO_SPEED_OK(x)        (1 << (((x) * 4) + 2))
#define FAN_CHx_INT_MANUAL_SPEED_CHANGE(x)  (1 << (((x) * 4) + 2))
#define FAN_CHx_INT_AUTO_SPEED_ERROR(x)     (1 << (((x) * 4) + 1))
#define FAN_CHx_INT_MANUAL_SPEED_UPDATE(x)  (1 << (((x) * 4) + 1))
#define FAN_CHx_INT_STALL(x)                (1 << ((x) * 4))

//*****************************************************************************
//
// API Function prototypes
//
//*****************************************************************************
extern void FanChannelEnable(unsigned long ulBase, unsigned long ulChannel);
extern void FanChannelDisable(unsigned long ulBase, unsigned long ulChannel);
extern unsigned long FanChannelStatus(unsigned long ulBase,
                                      unsigned long ulChannel);
extern void FanChannelConfigManual(unsigned long ulBase, unsigned long ulChannel,
                                   unsigned long ulConfig);
extern void FanChannelConfigAuto(unsigned long ulBase, unsigned long ulChannel,
                                 unsigned long ulConfig);
extern void FanChannelDutySet(unsigned long ulBase, unsigned long ulChannel,
                              unsigned long ulDuty);
extern unsigned long FanChannelDutyGet(unsigned long ulBase,
                                       unsigned long ulChannel);
extern void FanChannelRPMSet(unsigned long ulBase, unsigned long ulChannel,
                             unsigned long ulRPM);
extern unsigned long FanChannelRPMGet(unsigned long ulBase,
                                      unsigned long ulChannel);
extern void FanIntEnable(unsigned long ulBase, unsigned long ulFlags);
extern void FanIntDisable(unsigned long ulBase, unsigned long ulFlags);
extern unsigned long FanIntStatus(unsigned long ulBase, tBoolean bMasked);
extern void FanIntClear(unsigned long ulBase, unsigned long ulFlags);
extern void FanIntRegister(unsigned long ulBase, void (*pfnHandler)(void));
extern void FanIntUnregister(unsigned long ulBase);
extern unsigned long FanChannelsGet(unsigned long ulBase);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

#endif //  __FAN_H__