Implementation of ADE9000 Driver. More...
#include <stdlib.h>#include <errno.h>#include "ade9000.h"#include "no_os_delay.h"#include "no_os_units.h"#include "no_os_alloc.h"
Functions | |
| int | ade9000_read (struct ade9000_dev *dev, uint16_t reg_addr, uint32_t *reg_data) |
| Read device register. More... | |
| int | ade9000_write (struct ade9000_dev *dev, uint16_t reg_addr, uint32_t reg_data) |
| Write device register. More... | |
| int | ade9000_update_bits (struct ade9000_dev *dev, uint16_t reg_addr, uint32_t mask, uint32_t reg_data) |
| Update specific register bits. More... | |
| int | ade9000_get_int_status0 (struct ade9000_dev *dev, uint32_t msk, uint8_t *status) |
| Get interrupt indicator from STATUS0 register. More... | |
| int | ade9000_read_temp (struct ade9000_dev *dev) |
| Read the temperature. More... | |
| int | ade9000_read_data_ph (struct ade9000_dev *dev, enum ade9000_phase phase) |
| Read the power/energy for specific phase. More... | |
| int | ade9000_set_egy_model (struct ade9000_dev *dev, enum ade9000_egy_model model, uint16_t value) |
| Set User Energy use model. More... | |
| int | ade9000_init (struct ade9000_dev **device, struct ade9000_init_param init_param) |
| Initialize the device. More... | |
| int | ade9000_setup (struct ade9000_dev *dev) |
| Setup the device. More... | |
| int | ade9000_remove (struct ade9000_dev *dev) |
| Remove the device and release resources. More... | |
Detailed Description
Implementation of ADE9000 Driver.
Copyright 2024(c) Analog Devices, Inc.
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 Analog Devices, Inc. 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 ANALOG DEVICES, INC. “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 ANALOG DEVICES, INC. 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.
Function Documentation
◆ ade9000_get_int_status0()
| int ade9000_get_int_status0 | ( | struct ade9000_dev * | dev, |
| uint32_t | msk, | ||
| uint8_t * | status | ||
| ) |
Get interrupt indicator from STATUS0 register.
- Parameters
-
dev - The device structure. msk - Interrupt mask. status - Status indicator.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_init()
| int ade9000_init | ( | struct ade9000_dev ** | device, |
| struct ade9000_init_param | init_param | ||
| ) |
Initialize the device.
- Parameters
-
device - The device structure. init_param - The structure that contains the device initial parameters.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_read()
| int ade9000_read | ( | struct ade9000_dev * | dev, |
| uint16_t | reg_addr, | ||
| uint32_t * | reg_data | ||
| ) |
Read device register.
- Parameters
-
dev - The device structure. reg_addr - The register address. reg_data - The data read from the register.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_read_data_ph()
| int ade9000_read_data_ph | ( | struct ade9000_dev * | dev, |
| enum ade9000_phase | phase | ||
| ) |
Read the power/energy for specific phase.
- Parameters
-
dev - The device structure. phase - ADE9000 Phase.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_read_temp()
| int ade9000_read_temp | ( | struct ade9000_dev * | dev | ) |
Read the temperature.
- Parameters
-
dev - The device structure.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_remove()
| int ade9000_remove | ( | struct ade9000_dev * | dev | ) |
Remove the device and release resources.
- Parameters
-
dev - The device structure.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_set_egy_model()
| int ade9000_set_egy_model | ( | struct ade9000_dev * | dev, |
| enum ade9000_egy_model | model, | ||
| uint16_t | value | ||
| ) |
Set User Energy use model.
- Parameters
-
dev - The device structure. model - The User Energy use model to be set. value - value specific to the user energy use model, it can be either 1 for reading with reset, number of half line cycles or number of samples.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_setup()
| int ade9000_setup | ( | struct ade9000_dev * | dev | ) |
Setup the device.
- Parameters
-
dev - The device structure.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_update_bits()
| int ade9000_update_bits | ( | struct ade9000_dev * | dev, |
| uint16_t | reg_addr, | ||
| uint32_t | mask, | ||
| uint32_t | reg_data | ||
| ) |
Update specific register bits.
- Parameters
-
dev - The device structure. reg_addr - The register address. mask - Specific bits mask. reg_data - The data to be written.
- Returns
- 0 in case of success, negative error code otherwise.
◆ ade9000_write()
| int ade9000_write | ( | struct ade9000_dev * | dev, |
| uint16_t | reg_addr, | ||
| uint32_t | reg_data | ||
| ) |
Write device register.
- Parameters
-
dev- The device structure. reg_addr - The register address. reg_data - The data to be written.
- Returns
- 0 in case of success, negative error code otherwise.
