MSP432E4 DriverLib API Guide
1.11.00.03
tmp
bazel_docapi.z9EuJc
source
ti
devices
msp432e4
driverlib
inc
hw_onewire.h
Go to the documentation of this file.
1
//*****************************************************************************
2
//
3
// hw_onewire.h - Macros used when accessing the One wire hardware.
4
//
5
// Copyright (c) 2012-2017 Texas Instruments Incorporated. All rights reserved.
6
// Software License Agreement
7
//
8
// Redistribution and use in source and binary forms, with or without
9
// modification, are permitted provided that the following conditions
10
// are met:
11
//
12
// Redistributions of source code must retain the above copyright
13
// notice, this list of conditions and the following disclaimer.
14
//
15
// Redistributions in binary form must reproduce the above copyright
16
// notice, this list of conditions and the following disclaimer in the
17
// documentation and/or other materials provided with the
18
// distribution.
19
//
20
// Neither the name of Texas Instruments Incorporated nor the names of
21
// its contributors may be used to endorse or promote products derived
22
// from this software without specific prior written permission.
23
//
24
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
//
36
//*****************************************************************************
37
38
#ifndef __HW_ONEWIRE_H__
39
#define __HW_ONEWIRE_H__
40
41
//*****************************************************************************
42
//
43
// The following are defines for the One wire register offsets.
44
//
45
//*****************************************************************************
46
#define ONEWIRE_O_CS 0x00000000 // 1-Wire Control and Status
47
#define ONEWIRE_O_TIM 0x00000004 // 1-Wire Timing Override
48
#define ONEWIRE_O_DATW 0x00000008 // 1-Wire Data Write
49
#define ONEWIRE_O_DATR 0x0000000C // 1-Wire Data Read
50
#define ONEWIRE_O_IM 0x00000100 // 1-Wire Interrupt Mask
51
#define ONEWIRE_O_RIS 0x00000104 // 1-Wire Raw Interrupt Status
52
#define ONEWIRE_O_MIS 0x00000108 // 1-Wire Masked Interrupt Status
53
#define ONEWIRE_O_ICR 0x0000010C // 1-Wire Interrupt Clear
54
#define ONEWIRE_O_DMA 0x00000120 // 1-Wire uDMA Control
55
#define ONEWIRE_O_PP 0x00000FC0 // 1-Wire Peripheral Properties
56
57
//*****************************************************************************
58
//
59
// The following are defines for the bit fields in the ONEWIRE_O_CS register.
60
//
61
//*****************************************************************************
62
#define ONEWIRE_CS_USEALT 0x80000000 // Two Wire Enable
63
#define ONEWIRE_CS_ALTP 0x40000000 // Alternate Polarity Enable
64
#define ONEWIRE_CS_BSIZE_M 0x00070000 // Last Byte Size
65
#define ONEWIRE_CS_BSIZE_8 0x00000000 // 8 bits (1 byte)
66
#define ONEWIRE_CS_BSIZE_1 0x00010000 // 1 bit
67
#define ONEWIRE_CS_BSIZE_2 0x00020000 // 2 bits
68
#define ONEWIRE_CS_BSIZE_3 0x00030000 // 3 bits
69
#define ONEWIRE_CS_BSIZE_4 0x00040000 // 4 bits
70
#define ONEWIRE_CS_BSIZE_5 0x00050000 // 5 bits
71
#define ONEWIRE_CS_BSIZE_6 0x00060000 // 6 bits
72
#define ONEWIRE_CS_BSIZE_7 0x00070000 // 7 bits
73
#define ONEWIRE_CS_STUCK 0x00000400 // STUCK Status
74
#define ONEWIRE_CS_NOATR 0x00000200 // Answer-to-Reset Status
75
#define ONEWIRE_CS_BUSY 0x00000100 // Busy Status
76
#define ONEWIRE_CS_SKATR 0x00000080 // Skip Answer-to-Reset Enable
77
#define ONEWIRE_CS_LSAM 0x00000040 // Late Sample Enable
78
#define ONEWIRE_CS_ODRV 0x00000020 // Overdrive Enable
79
#define ONEWIRE_CS_SZ_M 0x00000018 // Data Operation Size
80
#define ONEWIRE_CS_OP_M 0x00000006 // Operation Request
81
#define ONEWIRE_CS_OP_NONE 0x00000000 // No operation
82
#define ONEWIRE_CS_OP_RD 0x00000002 // Read
83
#define ONEWIRE_CS_OP_WR 0x00000004 // Write
84
#define ONEWIRE_CS_OP_WRRD 0x00000006 // Write/Read
85
#define ONEWIRE_CS_RST 0x00000001 // Reset Request
86
#define ONEWIRE_CS_SZ_S 3
87
88
//*****************************************************************************
89
//
90
// The following are defines for the bit fields in the ONEWIRE_O_TIM register.
91
//
92
//*****************************************************************************
93
#define ONEWIRE_TIM_W1TIM_M 0xF0000000 // Value '1' Timing
94
#define ONEWIRE_TIM_W0TIM_M 0x0F800000 // Value '0' Timing
95
#define ONEWIRE_TIM_W0REST_M 0x00780000 // Rest Time
96
#define ONEWIRE_TIM_W1SAM_M 0x00078000 // Sample Time
97
#define ONEWIRE_TIM_ATRSAM_M 0x00007800 // Answer-to-Reset Sample
98
#define ONEWIRE_TIM_ATRTIM_M 0x000007C0 // Answer-to-Reset/Rest Period
99
#define ONEWIRE_TIM_RSTTIM_M 0x0000003F // Reset Low Time
100
#define ONEWIRE_TIM_W1TIM_S 28
101
#define ONEWIRE_TIM_W0TIM_S 23
102
#define ONEWIRE_TIM_W0REST_S 19
103
#define ONEWIRE_TIM_W1SAM_S 15
104
#define ONEWIRE_TIM_ATRSAM_S 11
105
#define ONEWIRE_TIM_ATRTIM_S 6
106
#define ONEWIRE_TIM_RSTTIM_S 0
107
108
//*****************************************************************************
109
//
110
// The following are defines for the bit fields in the ONEWIRE_O_DATW register.
111
//
112
//*****************************************************************************
113
#define ONEWIRE_DATW_B3_M 0xFF000000 // Upper Data Byte
114
#define ONEWIRE_DATW_B2_M 0x00FF0000 // Upper Middle Data Byte
115
#define ONEWIRE_DATW_B1_M 0x0000FF00 // Lower Middle Data Byte
116
#define ONEWIRE_DATW_B0_M 0x000000FF // Lowest Data Byte
117
#define ONEWIRE_DATW_B3_S 24
118
#define ONEWIRE_DATW_B2_S 16
119
#define ONEWIRE_DATW_B1_S 8
120
#define ONEWIRE_DATW_B0_S 0
121
122
//*****************************************************************************
123
//
124
// The following are defines for the bit fields in the ONEWIRE_O_DATR register.
125
//
126
//*****************************************************************************
127
#define ONEWIRE_DATR_B3_M 0xFF000000 // Upper Data Byte
128
#define ONEWIRE_DATR_B2_M 0x00FF0000 // Upper Middle Data Byte
129
#define ONEWIRE_DATR_B1_M 0x0000FF00 // Lower Middle Data Byte
130
#define ONEWIRE_DATR_B0_M 0x000000FF // Lowest Data Byte
131
#define ONEWIRE_DATR_B3_S 24
132
#define ONEWIRE_DATR_B2_S 16
133
#define ONEWIRE_DATR_B1_S 8
134
#define ONEWIRE_DATR_B0_S 0
135
136
//*****************************************************************************
137
//
138
// The following are defines for the bit fields in the ONEWIRE_O_IM register.
139
//
140
//*****************************************************************************
141
#define ONEWIRE_IM_DMA 0x00000010 // DMA Done Interrupt Mask
142
#define ONEWIRE_IM_STUCK 0x00000008 // Stuck Status Interrupt Mask
143
#define ONEWIRE_IM_NOATR 0x00000004 // No Answer-to-Reset Interrupt
144
// Mask
145
#define ONEWIRE_IM_OPC 0x00000002 // Operation Complete Interrupt
146
// Mask
147
#define ONEWIRE_IM_RST 0x00000001 // Reset Interrupt Mask
148
149
//*****************************************************************************
150
//
151
// The following are defines for the bit fields in the ONEWIRE_O_RIS register.
152
//
153
//*****************************************************************************
154
#define ONEWIRE_RIS_DMA 0x00000010 // DMA Done Raw Interrupt Status
155
#define ONEWIRE_RIS_STUCK 0x00000008 // Stuck Status Raw Interrupt
156
// Status
157
#define ONEWIRE_RIS_NOATR 0x00000004 // No Answer-to-Reset Raw Interrupt
158
// Status
159
#define ONEWIRE_RIS_OPC 0x00000002 // Operation Complete Raw Interrupt
160
// Status
161
#define ONEWIRE_RIS_RST 0x00000001 // Reset Raw Interrupt Status
162
163
//*****************************************************************************
164
//
165
// The following are defines for the bit fields in the ONEWIRE_O_MIS register.
166
//
167
//*****************************************************************************
168
#define ONEWIRE_MIS_DMA 0x00000010 // DMA Done Masked Interrupt Status
169
#define ONEWIRE_MIS_STUCK 0x00000008 // Stuck Status Masked Interrupt
170
// Status
171
#define ONEWIRE_MIS_NOATR 0x00000004 // No Answer-to-Reset Masked
172
// Interrupt Status
173
#define ONEWIRE_MIS_OPC 0x00000002 // Operation Complete Masked
174
// Interrupt Status
175
#define ONEWIRE_MIS_RST 0x00000001 // Reset Interrupt Mask
176
177
//*****************************************************************************
178
//
179
// The following are defines for the bit fields in the ONEWIRE_O_ICR register.
180
//
181
//*****************************************************************************
182
#define ONEWIRE_ICR_DMA 0x00000010 // DMA Done Interrupt Clear
183
#define ONEWIRE_ICR_STUCK 0x00000008 // Stuck Status Interrupt Clear
184
#define ONEWIRE_ICR_NOATR 0x00000004 // No Answer-to-Reset Interrupt
185
// Clear
186
#define ONEWIRE_ICR_OPC 0x00000002 // Operation Complete Interrupt
187
// Clear
188
#define ONEWIRE_ICR_RST 0x00000001 // Reset Interrupt Clear
189
190
//*****************************************************************************
191
//
192
// The following are defines for the bit fields in the ONEWIRE_O_DMA register.
193
//
194
//*****************************************************************************
195
#define ONEWIRE_DMA_SG 0x00000008 // Scatter-Gather Enable
196
#define ONEWIRE_DMA_DMAOP_M 0x00000006 // uDMA Operation
197
#define ONEWIRE_DMA_DMAOP_DIS 0x00000000 // uDMA disabled
198
#define ONEWIRE_DMA_DMAOP_RDSNG 0x00000002 // uDMA single read: 1-Wire
199
// requests uDMA to read
200
// ONEWIREDATR register after each
201
// read transaction
202
#define ONEWIRE_DMA_DMAOP_WRMUL 0x00000004 // uDMA multiple write: 1-Wire
203
// requests uDMA to load whenever
204
// the ONEWIREDATW register is
205
// empty
206
#define ONEWIRE_DMA_DMAOP_RDMUL 0x00000006 // uDMA multiple read: An initial
207
// read occurs and subsequent reads
208
// start after uDMA has read the
209
// ONEWIREDATR register
210
#define ONEWIRE_DMA_RST 0x00000001 // uDMA Reset
211
212
//*****************************************************************************
213
//
214
// The following are defines for the bit fields in the ONEWIRE_O_PP register.
215
//
216
//*****************************************************************************
217
#define ONEWIRE_PP_DMAP 0x00000010 // uDMA Present
218
#define ONEWIRE_PP_CNT_M 0x00000003 // 1-Wire Bus Count
219
#define ONEWIRE_PP_CNT_S 0
220
221
#endif // __HW_ONEWIRE_H__
© Copyright 1995-2019
, Texas Instruments Incorporated. All rights reserved.
Trademarks
|
Privacy policy
|
Terms of use
|
Terms of sale
