dcmotor10  2.0.0.0
dcmotor10.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef DCMOTOR10_H
36 #define DCMOTOR10_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_spi_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
53 #define DCMOTOR10_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
58  cfg.inh = MIKROBUS( mikrobus, MIKROBUS_INT )
59 
65 #define DCMOTOR10_RETVAL uint8_t
66 
67 #define DCMOTOR10_OK 0x00
68 #define DCMOTOR10_INIT_ERROR 0xFF
69 
75 #define DCMOTOR10_STATUS_REG_RST 0x0001
76 #define DCMOTOR10_LS_SWITCH_1 0x0002
77 #define DCMOTOR10_HS_SWITCH_1 0x0004
78 #define DCMOTOR10_LS_SWITCH_2 0x0008
79 #define DCMOTOR10_HS_SWITCH_2 0x0010
80 #define DCMOTOR10_LS_SWITCH_3 0x0020
81 #define DCMOTOR10_HS_SWITCH_3 0x0040
82 #define DCMOTOR10_LS_SWITCH_4 0x0080
83 #define DCMOTOR10_HS_SWITCH_4 0x0100
84 #define DCMOTOR10_LS_SWITCH_5 0x0200
85 #define DCMOTOR10_HS_SWITCH_5 0x0400
86 #define DCMOTOR10_LS_SWITCH_6 0x0800
87 #define DCMOTOR10_HS_SWITCH_6 0x1000
88 #define DCMOTOR10_OVERCURRENT_SHUT_DOWN 0x2000
89 #define DCMOTOR10_UNDERLOAD_SHUT_DOWN 0x4000
90 #define DCMOTOR10_OVER_VOLT_LOCKOUT 0x8000
91 
97 #define DCMOTOR10_TEMP_PREWARNING 0x0001
98 #define DCMOTOR10_STATUS_LS_SWITCH_1 0x0002
99 #define DCMOTOR10_STATUS_HS_SWITCH_1 0x0004
100 #define DCMOTOR10_STATUS_LS_SWITCH_2 0x0008
101 #define DCMOTOR10_STATUS_HS_SWITCH_2 0x0010
102 #define DCMOTOR10_STATUS_LS_SWITCH_3 0x0020
103 #define DCMOTOR10_STATUS_HS_SWITCH_3 0x0040
104 #define DCMOTOR10_STATUS_LS_SWITCH_4 0x0080
105 #define DCMOTOR10_STATUS_HS_SWITCH_4 0x0100
106 #define DCMOTOR10_STATUS_LS_SWITCH_5 0x0200
107 #define DCMOTOR10_STATUS_HS_SWITCH_5 0x0400
108 #define DCMOTOR10_STATUS_LS_SWITCH_6 0x0800
109 #define DCMOTOR10_STATUS_HS_SWITCH_6 0x1000
110 #define DCMOTOR10_OVERLOAD 0x2000
111 #define DCMOTOR10_UNDERLOAD 0x4000
112 #define DCMOTOR10_POWER_SUPPLY_FAIL 0x8000
113 
119 #define DCMOTOR10_OVERCURRENT_FAULT 0x2000
120 #define DCMOTOR10_GND_SHORT_CIRCUIT 0x2000
121 #define DCMOTOR10_VS_SHORT_CIRCUIT 0x2000
122 #define DCMOTOR10_TEMP_WARNING 0x0001
123 #define DCMOTOR10_OPENLOAD_FAULT 0x4000
124 #define DCMOTOR10_UNDERLOAD_FAULT 0x4000
125 #define DCMOTOR10_UNDER_VOLT_LOCKOUT_FAULT 0x8000
126 #define DCMOTOR10_OVER_VOLT_LOCKOUT_FAULT 0x8000
127 
133 #define DCMOTOR10_RESET_STATUS_REG 0x0001
134 #define DCMOTOR10_ENABLE_1 0x000E
135 #define DCMOTOR10_ENABLE_2 0x0038
136 #define DCMOTOR10_ENABLE_3 0x00E0
137 #define DCMOTOR10_ENABLE_4 0x0380
138 #define DCMOTOR10_ENABLE_5 0x0E00
139 #define DCMOTOR10_ENABLE_6 0x3800
140 #define DCMOTOR10_ENABLE_ALL 0x1FFE
141 
147 #define DCMOTOR10_HB_ENABLE_1_CV 0x000C
148 #define DCMOTOR10_HB_ENABLE_1_CCV 0x0012
149 #define DCMOTOR10_HB_ENABLE_2_CV 0x0030
150 #define DCMOTOR10_HB_ENABLE_2_CCV 0x0048
151 #define DCMOTOR10_HB_ENABLE_3_CV 0x00C0
152 #define DCMOTOR10_HB_ENABLE_3_CCV 0x0120
153 #define DCMOTOR10_HB_ENABLE_4_CV 0x0300
154 #define DCMOTOR10_HB_ENABLE_4_CCV 0x0480
155 #define DCMOTOR10_HB_ENABLE_5_CV 0x0C00
156 #define DCMOTOR10_HB_ENABLE_5_CCV 0x1200
157 
163 #define DCMOTOR10_8_BIT_DATA 0xFF
164 #define DCMOTOR10_INHIBIT 0x00
165 #define DCMOTOR10_UNINHIBIT 0x01
166  // End group macro
169 // --------------------------------------------------------------- PUBLIC TYPES
178 typedef struct
179 {
180  // Output pins
181 
182  digital_out_t inh;
183 
184  // Modules
185 
186  spi_master_t spi;
187 
188 } dcmotor10_t;
189 
193 typedef struct
194 {
195  // Communication gpio pins
196 
197  pin_name_t miso;
198  pin_name_t mosi;
199  pin_name_t sck;
200  pin_name_t cs;
201 
202  // Additional gpio pins
203 
204  pin_name_t inh;
205 
206  // static variable
207 
208  hal_spi_speed_t spi_speed;
209  hal_spi_mode_t spi_mode;
210 
212  // End types group
214 // ------------------------------------------------------------------ CONSTANTS // End constants group
223 // ------------------------------------------------------------------ VARIABLES // End variable group
231 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
232 
237 #ifdef __cplusplus
238 extern "C"{
239 #endif
240 
250 
259 
269 void dcmotor10_send_cmd ( dcmotor10_t *ctx, uint16_t wr_data );
270 
281 uint16_t dcmotor10_read_status ( dcmotor10_t *ctx );
282 
291 void dcmotor10_inhibit ( dcmotor10_t *ctx, uint8_t state );
292 
293 #ifdef __cplusplus
294 }
295 #endif
296 #endif // _DCMOTOR10_H_
297  // End public_function group
300 
301 // ------------------------------------------------------------------------- END
dcmotor10_cfg_t::miso
pin_name_t miso
Definition: dcmotor10.h:197
dcmotor10_cfg_t
Click configuration structure definition.
Definition: dcmotor10.h:193
DCMOTOR10_RETVAL
#define DCMOTOR10_RETVAL
Definition: dcmotor10.h:65
dcmotor10_t::spi
spi_master_t spi
Definition: dcmotor10.h:186
dcmotor10_read_status
uint16_t dcmotor10_read_status(dcmotor10_t *ctx)
Read status function.
dcmotor10_init
DCMOTOR10_RETVAL dcmotor10_init(dcmotor10_t *ctx, dcmotor10_cfg_t *cfg)
Initialization function.
dcmotor10_cfg_setup
void dcmotor10_cfg_setup(dcmotor10_cfg_t *cfg)
Config Object Initialization function.
dcmotor10_send_cmd
void dcmotor10_send_cmd(dcmotor10_t *ctx, uint16_t wr_data)
Send command function.
dcmotor10_cfg_t::sck
pin_name_t sck
Definition: dcmotor10.h:199
dcmotor10_cfg_t::spi_speed
hal_spi_speed_t spi_speed
Definition: dcmotor10.h:208
dcmotor10_cfg_t::cs
pin_name_t cs
Definition: dcmotor10.h:200
dcmotor10_cfg_t::inh
pin_name_t inh
Definition: dcmotor10.h:204
dcmotor10_cfg_t::spi_mode
hal_spi_mode_t spi_mode
Definition: dcmotor10.h:209
dcmotor10_cfg_t::mosi
pin_name_t mosi
Definition: dcmotor10.h:198
dcmotor10_t::inh
digital_out_t inh
Definition: dcmotor10.h:182
dcmotor10_inhibit
void dcmotor10_inhibit(dcmotor10_t *ctx, uint8_t state)
Inhibit device function.
dcmotor10_t
Click ctx object definition.
Definition: dcmotor10.h:178