RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Driver for the LM75A Digital temperature sensor and thermal watchdog

Browse Source
This commit is contained in:
Zakaria Kasmi 2013-08-12 12:44:42 +02:00 committed by Oleg Hahm
parent 4f4501f09d
commit 71cab78275
4 changed files with 481 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
drivers/Makefile
View File

@ -32,6 +32,9 @@ endif
ifneq (,$(findstring srf08,$(USEMODULE)))
DIRS += srf08
endif
ifneq (,$(findstring lm75a,$(USEMODULE)))
DIRS += lm75a
endif
all:
@for i in $(DIRS) ; do "$(MAKE)" -C $$i ; done ;

186
drivers/include/lm75a-temp-sensor.h
View File

@ -1,15 +1,23 @@
/*
<<<<<<< HEAD
* lm75a-temp-sensor.h - Definitions of the LM75A temperature sensor driver.
*
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
=======
* lm75a-temp-sensor.h - Definitions of the LM75A temperature sensor driver for the LPC2387 chip.
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
* See the file LICENSE for more details.
*/
/**
* @file
* @internal
<<<<<<< HEAD
* @brief Definitions of the LM75A temperature sensor driver.
*
* The connection between the LM75A and the MCU is based
@ -20,6 +28,16 @@
* @version $Revision: 3859 $
*
* @note $Id: lm75a-temp-sensor.h 3854 2013-09-2 15:35:21 kasmi $
=======
* @brief Definitions of the LM75A temperature sensor driver for the LPC2387 chip.
* The connection between the LM75A and the LPC2387 chip is based on the I2C-interface.
*
* @author Freie Universität Berlin, Computer Systems & Telematics
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @version $Revision: 3854 $
*
* @note $Id: lm75a-temp-sensor.h 3854 2013-06-19 12:27:01Z zkasmi $
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*/
#ifndef LM75A_H_
@ -30,6 +48,7 @@
#include "i2c.h"
/* LM75A register addresses */
<<<<<<< HEAD
#define LM75A_ADDR 0x48
#define LM75A_TEMPERATURE_REG 0x0
#define LM75A_CONFIG_REG 0x1
@ -80,10 +99,63 @@ enum FAULT_QUEUE_VALUES {
LM75A_TWO_FAULT = 2,
LM75A_FOUR_FAULT = 4,
LM75A_SIX_FAULT = 6
=======
#define LM75A_ADDR 0x48
#define LM75A_TEMPERATURE_REG 0x0
#define LM75A_CONFIG_REG 0x1
#define LM75A_THYST_REG 0x2
#define LM75A_OVER_TEMP_REG 0x3
/* Define the used I2C Interface */
//#define LM75A_I2C_INTERFACE I2C0 // P0.27 SDA0, P0.28 SCL0
#define LM75A_I2C_INTERFACE I2C1_0 // P0.0 SDA1, P0.1 SCL1
//#define LM75A_I2C_INTERFACE I2C1_1 // P0.19 SDA1, P0.20 SCL1
//#define LM75A_I2C_INTERFACE I2C2 // P0.10 SDA2, P0.11 SCL2
/* LM75A operation modes */
enum OPERATION_MODES {
LM75A_NORMAL_OPERATION_MODE,
LM75A_SHUTDOWN_MODE,
LM75A_COMPARATOR_MODE,
LM75A_INTERRUPT_MODE
};
/*Common definitions for LMA75A */
#define LM75A_BIT0 0x0
#define LM75A_BIT1 0x1
#define LM75A_BIT2 0x2
#define LM75A_BIT3 0x3
#define LM75A_BIT4 0x4
#define LM75A_BIT5 0x5
#define LM75A_BIT6 0x6
#define LM75A_BIT7 0x7
#define LM75A_BIT8 0x8
#define LM75A_BIT9 0x9
#define LM75A_BIT10 0xA
#define LM75A_BIT15 0xF
#define LM75A_MOST_SIG_BYTE_MASK 0xFF00
#define LM75A_LEAST_SIG_BYTE_MASK 0x00FF
#define LM75A_DATA_BITS_MASK 0x07FF
#define LM75A_SIGN_BIT_MASK (1<<LM75A_BIT10)
#define LM75A_LSB_MASK 0x1
#define LM75A_EXTINT_MODE 0x1
/* LM75A configuration register */
#define LM75A_ACTIVE_LOW 0
#define LM75A_ACTIVE_HIGH 1
#define LM75A_DEFAULT_CONFIG_VALUE 0
enum FAULT_QUEUE_VALUES {
LM75A_ONE_FAULT = 1,
LM75A_TWO_FAULT = 2,
LM75A_FOUR_FAULT = 4,
LM75A_SIX_FAULT = 6
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
};
/* LM75A default values */
enum DEFAULT_VALUES {
<<<<<<< HEAD
LM75A_DEFAULT_TOS = 80,
LM75A_DEFAULT_THYST = 75,
LM75A_DEFAULT_OPERATION = LM75A_NORMAL_OPERATION_MODE,
@ -102,21 +174,48 @@ enum DEFAULT_VALUES {
* @brief Set the over-temperature shutdown threshold (TOS).
*
* @param[in] tos the TOS value.
=======
LM75A_DEFAULT_TOS = 80,
LM75A_DEFAULT_THYST = 75,
LM75A_DEFAULT_OPERATION = LM75A_NORMAL_OPERATION_MODE,
LM75A_DEFAULT_MODE = LM75A_COMPARATOR_MODE,
LM75A_DEFAULT_POLARITY = LM75A_ACTIVE_LOW,
LM75A_DEFAULT_FAULT_NUM = LM75A_ONE_FAULT
};
/*define inter-threads messages */
#define LM75A_EXIT_MSG 0
#define LM75A_SAMPLING_MSG 1
#define LM75A_SLEEP_MSG 2
#define LM75A_WEAKUP_MSG 3
/**
* @brief Set the over-temperature shutdown threshold (TOS).
*
* @param[in] tos the TOS value.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
*/
void lm75A_set_over_temperature(float_t tos);
/**
<<<<<<< HEAD
* @brief Set the hysteresis temperature.
*
* @param[in] thsyt the hysteresis value.
=======
* @brief Set the hysteresis temperature.
*
* @param[in] thsyt the hysteresis value.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
*/
void lm75A_set_hysteresis_temperature(float_t thsyt);
/**
<<<<<<< HEAD
* @brief Set various operation modes of the temperature sensor.
* The LM75A provide four modes: normal, comparator, interrupt,
* and the shutdown mode.
@ -124,13 +223,24 @@ void lm75A_set_hysteresis_temperature(float_t thsyt);
*
* @param[in] op_mode the operation mode value: the normal, shutdown,
* comparator, or interrupt mode.
=======
* @brief Set various operation modes of the temperature sensor.
* The LM75A provide four modes: normal, comparator, interrupt, and the shutdown mode.
* All these modes are defined in the lm75a-temp-sensor.h
*
* @param[in] op_mode the operation mode value: the normal, shutdown, comparator, or interrupt mode.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
*/
void lm75A_set_operation_mode(uint8_t op_mode);
/**
<<<<<<< HEAD
* @brief Get the content of the configuration register.
=======
* @brief Get the content of the configuration register.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
* @return the configuration register value.
*
@ -139,7 +249,11 @@ uint8_t lm75A_get_config_reg(void);
/**
<<<<<<< HEAD
* @brief Get the adjusted hysteresis temperature.
=======
* @brief Get the adjusted hysteresis temperature.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
* @return the content of the hysteresis register.
*
@ -148,7 +262,11 @@ float_t lm75A_get_hysteresis_temperature(void);
/**
<<<<<<< HEAD
* @brief Get the adjusted over-temperature shutdown threshold (TOS).
=======
* @brief Get the adjusted over-temperature shutdown threshold (TOS).
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
* @return the content of the TOS-register.
*
@ -157,8 +275,12 @@ float_t lm75A_get_over_temperature(void);
/**
<<<<<<< HEAD
* @brief Get the ambient temperature which is measured from the
* LM75A sensor.
=======
* @brief Get the ambient temperature which is measured from the LM75A sensor.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
* @return the content of the temperature register.
*
@ -167,15 +289,22 @@ float_t lm75A_get_ambient_temperature(void);
/**
<<<<<<< HEAD
* @brief Set the LM75A sensor in the initial state.
* The temperature sensor has the following values in this state:
* config_register = 0; hyst_register = 75; the tos_reg = 80.
=======
* @brief Set the LM75A sensor in the initial state.
* The temperature sensor has the following values in this state:
* config_register = 0; hyst_register = 75; the tos_reg = 80.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
*/
void lm75A_reset(void);
/**
<<<<<<< HEAD
* @brief Start a continuous sampling of the temperature values.
* This function prints the values of all registers over
* the rs232 interface.
@ -186,11 +315,20 @@ void lm75A_reset(void);
* subroutine is leaved. This parameter
* is optional, the NULL-value can be
* entered.
=======
* @brief Start a continuous sampling of the temperature values.
* This function prints the values of all registers over the rs232 interface.
*
*@param[in] external_interr_handler pointer to an external task handler which is performed, if an external
* interrupt is occurred and the external subroutine is leaved. This parameter
* is optional, the NULL-value can be entered.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*/
void lm75A_start_sensor_sampling(void (*extern_interrupt_task)(void));
/**
<<<<<<< HEAD
* @brief Register an interrupt handler for the external interrupt.
* Only the port0 and port2 are supported.
*
@ -247,6 +385,54 @@ bool lm75A_external_interrupt_register(void *handler);
* @brief Alarm the sensor sampling task about an external interrupt.
*
* @param[in] b is true if an external interrupt is occurred, otherwise false.
=======
* @brief Register an interrupt handler for the external interrupt.
* Only the port0 and port2 are supported.
*
* @param[in] port port number.
* @param[in] pin_bit_mask pin number in form of a bit mask: Pin0 --> BIT0, Pin1 --> BIT1, Pin2 --> BIT2 = 2^2 = 4
* @param[in] flags define if the interrupt is generated on rising or falling edge (#GPIOINT_RISING_EDGE,
* #GPIOINT_FALLING_EDGE).
* @param[in] handler pointer to an interrupt handler.
*
* @return true if the the external interrupt handler is successfully registered, otherwise false.
*/
bool lm75A_ext_irq_handler_register(int32_t port, uint32_t pin_bit_mask,
int32_t flags, void* handler);
/**
* @brief Initialize the LM75A temperature sensor.
* The baud rate and the handler for the external interrupt can be initialized. The external interrupt
* handler is optional, if no handler is available, the NULL-value can be entered. The hysteresis and
* the over-temperature are displayed before and after a rest action is performed. After this the LM7A
* sensor is set in the interrupt or the comparator mode.
*
* @param[in] i2c_interface the i2c interface, several interfaces can be selected: i2c0, i2c1 and i2c2.
* @param[in] baud_rate the baud rate.
* @param[in] external_interr_handler pointer to a handler for the external interrupt.
*
* @return true if the I2C interface and the external interrupt handler are successfully initialized, otherwise false.
*/
bool lm75A_init(uint8_t i2c_interface, uint32_t baud_rate,
void* external_interr_handler);
/**
* @brief Register the external interrupt handler for the over-temperature shutdown output.
*
* @param[in] handler pointer to a handler for the external interrupts.
*
* @return true if the the external interrupt handler is successfully registered, otherwise false.
*/
bool lm75A_external_interrupt_register(void* handler);
/**
* @brief Alarm the sensor sampling task about an external interrupt.
*
* @param[in] b is true if an external interrupt is occurred, otherwise false.
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*
*/
void lm75A_set_in_alarm(bool b);

5
drivers/lm75a/Makefile Normal file
View File

@ -0,0 +1,5 @@
INCLUDES = -I$(RIOTBASE)/core/include -I../include/ -I$(RIOTBASE)/sys/include
MODULE =lm75a
include $(MAKEBASE)/Makefile.base

287
drivers/lm75a/lm75a-temp-sensor.c
View File

@ -1,10 +1,17 @@
/*
<<<<<<< HEAD
* lm75a-temp-sensor.c - Driver for the LM75A temperature sensor based on the
* i2c interface.
*
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
=======
* lm75a-temp-sensor.c - Driver for the LM75A temperature sensor using the LPC2387 and based on the i2c interface.
* Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
*
* This source code is licensed under the LGPLv2 license,
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
* See the file LICENSE for more details.
*
*/
@ -12,6 +19,7 @@
/**
* @file
* @internal
<<<<<<< HEAD
* @brief Driver for the LM75A temperature sensor.
* The communication between the LM75A and the MCU is
* based on the i2c interface.
@ -21,6 +29,16 @@
* @version $Revision: 3854 $
*
* @note $Id: lm75a-temp-sensor.c 3854 2013-09-03 13:56:47 kasmi $
=======
* @brief Driver for the LM75A temperature sensor and the LPC2387 chip.
* The communication between the LM75A and the LPC2387 chip is based on the i2c interface.
*
* @author Freie Universität Berlin, Computer Systems & Telematics
* @author Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
* @version $Revision: 3854 $
*
* @note $Id: lm75a-temp-sensor.c 3854 2013-05-14 15:27:01Z zkasmi $
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
*/
#include <stdlib.h>
@ -40,6 +58,7 @@
#include "hwtimer.h"
#include "board.h"
<<<<<<< HEAD
//declaration as volatile is important, otherwise no interrupt is triggered.
volatile bool my_alarm = false;
@ -303,11 +322,255 @@ bool lm75A_init(uint8_t i2c_interface, uint32_t baud_rate,
void lm75A_set_in_alarm(bool b)
{
my_alarm = b;
=======
volatile bool my_alarm = false; //wichtig sonst wird kein Interrupt gelöst.
static uint16_t get_2s_complement(uint16_t num) {
return ~(num) + 1;
}
//Write: MC --> Sensor
static void to_bytes(float_t f, uint8_t* buff) {
int32_t i = (int32_t)(f * 2);
buff[0] = (uint8_t)((i >> LM75A_BIT1) & 0xFF); //Most significant byte
buff[1] = (uint8_t)((i & LM75A_BIT1) << LM75A_BIT7); //Least significant byte
}
static uint16_t to_uint16(uint8_t* buff) {
if (buff != NULL) {
return (buff[0] << LM75A_BIT8) | buff[1];
} else {
return UINT16_MAX;
}
}
//Read: Sensor --> MC
volatile static float_t to_float(uint8_t reg_addr, uint16_t reg_value) {
uint16_t sign = reg_value & LM75A_SIGN_BIT_MASK;
float_t f_temp = 0.0;
float_t factor = 0.0;
switch (reg_addr) {
case LM75A_OVER_TEMP_REG:
case LM75A_THYST_REG:
factor = 0.5;
break;
case LM75A_TEMPERATURE_REG:
factor = 0.125;
}
if (sign) { //the number is negative
f_temp = (get_2s_complement(reg_value) & LM75A_DATA_BITS_MASK)
* -factor;
} else { //the number is positive
f_temp = reg_value * factor;
}
return f_temp;
}
static void set_register(uint8_t i2c_interface, uint8_t reg_addr, float_t value) {
bool status = false;
uint8_t tx_buff[2];
switch (reg_addr) {
case LM75A_OVER_TEMP_REG:
case LM75A_THYST_REG:
to_bytes(value, tx_buff);
status = i2c_write(i2c_interface, LM75A_ADDR, reg_addr, tx_buff, 2);
break;
case LM75A_CONFIG_REG:
tx_buff[0] = (uint8_t) value;
status = i2c_write(i2c_interface, LM75A_ADDR, reg_addr, tx_buff, 1);
}
if (!status) {
puts(
"[lm75a_tempSensorI2C/lm75A_setRegister]: Slave is not ready !!\n");
}
}
void lm75A_set_over_temperature(float_t tos) {
set_register(LM75A_I2C_INTERFACE, LM75A_OVER_TEMP_REG, tos);
}
void lm75A_set_hysteresis_temperature(float_t thsyt) {
set_register(LM75A_I2C_INTERFACE, LM75A_THYST_REG, thsyt);
}
static uint16_t lm75A_get_register_value(uint8_t i2c_interface,
uint8_t reg_addr, uint8_t reg_size) {
bool status = false;
uint8_t rx_buff[reg_size];
i2c_clear_buffer(rx_buff, reg_size);
if ((reg_size > 0) && (reg_size < 3)) {
status = i2c_read(i2c_interface, LM75A_ADDR, reg_addr, rx_buff,
reg_size);
if (!status) { //Slave is not ready
puts(
"[lm75a_tempSensorI2C/lm75A_getConfigReg]: Slave is not ready !\n");
if (reg_size < 2) {
return UCHAR_MAX;
} else {
return UINT16_MAX;
}
} else { //Slave acknowledged
if (reg_size < 2) {
return rx_buff[0];
} else {
return to_uint16(rx_buff);
}
}
} else {
puts("the register size must be less than 2");
return UINT16_MAX;
}
}
uint8_t lm75A_get_config_reg(void) {
return lm75A_get_register_value(LM75A_I2C_INTERFACE, LM75A_CONFIG_REG, 1);
}
float_t lm75A_get_hysteresis_temperature(void) {
uint16_t hyst_reg_value = 0;
hyst_reg_value = lm75A_get_register_value(LM75A_I2C_INTERFACE,
LM75A_THYST_REG, 2);
hyst_reg_value = (hyst_reg_value >> LM75A_BIT7);
return to_float(LM75A_THYST_REG, hyst_reg_value);
}
float_t lm75A_get_over_temperature(void) {
uint16_t over_temp = 0;
over_temp = lm75A_get_register_value(LM75A_I2C_INTERFACE,
LM75A_OVER_TEMP_REG, 2);
over_temp = (over_temp >> LM75A_BIT7);
return to_float(LM75A_OVER_TEMP_REG, over_temp);
}
float_t lm75A_get_ambient_temperature(void) {
uint16_t amb_temp = 0;
amb_temp = lm75A_get_register_value(LM75A_I2C_INTERFACE,
LM75A_TEMPERATURE_REG, 2);
amb_temp = (amb_temp >> LM75A_BIT5);
return to_float(LM75A_TEMPERATURE_REG, amb_temp);
}
void lm75A_reset(void) {
lm75A_set_over_temperature(LM75A_DEFAULT_TOS);
lm75A_set_hysteresis_temperature(LM75A_DEFAULT_THYST);
set_register(LM75A_I2C_INTERFACE, LM75A_CONFIG_REG,
LM75A_DEFAULT_CONFIG_VALUE);
}
void lm75A_set_operation_mode(uint8_t op_mode) {
uint8_t config_reg = lm75A_get_config_reg();
switch (op_mode) {
case LM75A_NORMAL_OPERATION_MODE:
config_reg &= ~(1 << LM75A_BIT0);
break;
case LM75A_SHUTDOWN_MODE:
config_reg |= (1 << LM75A_BIT0);
break;
case LM75A_COMPARATOR_MODE:
config_reg &= ~(1 << LM75A_BIT1);
break;
case LM75A_INTERRUPT_MODE:
config_reg |= (1 << LM75A_BIT1);
break;
default:
config_reg &= ~(1 << LM75A_BIT0);
}
set_register(LM75A_I2C_INTERFACE, LM75A_CONFIG_REG, config_reg);
}
bool lm75A_ext_irq_handler_register(int32_t port, uint32_t pin_bit_mask,
int32_t flags, void* handler) {
return gpioint_set(port, pin_bit_mask, flags, handler);
}
bool lm75A_init(uint8_t i2c_interface, uint32_t baud_rate,
void* external_interr_handler) {
if (i2c_initialize(i2c_interface, (uint32_t) I2CMASTER, 0, baud_rate, NULL)
== false) /* initialize I2C */
{
puts("fatal error! happened in i2cInitialize() \n");
while (1)
; /* Fatal error */
}
//i2c_enable_pull_up_resistor(i2c_interface);
i2c_disable_pull_up_resistor(i2c_interface);
if ((external_interr_handler != NULL)
&& lm75A_ext_irq_handler_register(2, BIT3, GPIOINT_FALLING_EDGE,
external_interr_handler)) {
printf("# %-70s%10s\n", "External interrupt handler registration",
"...[OK]");
} else {
printf("# %-70s%10s\n", "External interrupt handler registration",
"...[FAILED]");
return false;
}
//Disable pull-up resistors
puts("################## Before reset ##################");
printf("configReg = %u\n", lm75A_get_config_reg());
printf("hystTemp = %f\n", lm75A_get_hysteresis_temperature());
printf("overTemp = %f\n", lm75A_get_over_temperature());
lm75A_reset();
puts("\n################## After reset ##################");
printf("configRegInitial = %u\n", lm75A_get_config_reg());
printf("initialHystTemp = %f\n", lm75A_get_hysteresis_temperature());
printf("initialOverTemp = %f\n", lm75A_get_over_temperature());
puts("\n################## New configuration ##################");
// set the hysteresis temperature
lm75A_set_hysteresis_temperature(32.0);
printf("hystTemp = %f\n", lm75A_get_hysteresis_temperature());
lm75A_set_over_temperature(33.0);
printf("overTemp = %f\n", lm75A_get_over_temperature());
puts("\n################## Go to comparator mode ##################");
lm75A_set_operation_mode(LM75A_COMPARATOR_MODE);
printf("configReg = %u\n", lm75A_get_config_reg());
// puts("\n################## Go to interrupt mode ##################");
// lm75A_set_operation_mode(LM75A_INTERRUPT_MODE);
// printf("configReg = %u\n", lm75A_get_config_reg());
return true;
}
void lm75A_set_in_alarm(bool b) {
my_alarm = b;
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog
}
/*
* Application entry point.
*/
<<<<<<< HEAD
void lm75A_start_sensor_sampling(void (*handler)(void))
{
/*
@ -331,3 +594,27 @@ void lm75A_start_sensor_sampling(void (*handler)(void))
}
=======
void lm75A_start_sensor_sampling(void (*handler)(void)) {
/*
* Normal main() thread activity.
*/
while (true) {
//Toggle the green LED;
LED_RED_TOGGLE;
printf("amb_temp = %3.3f\n", lm75A_get_ambient_temperature());
if (my_alarm && (handler != NULL)) {
LED_GREEN_ON;
handler();
my_alarm = false;
}
hwtimer_wait(HWTIMER_TICKS(100000));
LED_RED_TOGGLE;
hwtimer_wait(HWTIMER_TICKS(100000));
}
}
>>>>>>> 5953946... Driver for the LM75A Digital temperature sensor and thermal watchdog