This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
resources:tools-software:uc-drivers:renesas:adp5589 [13 Sep 2012 09:15] – added setPin function Dragos Bogdan | resources:tools-software:uc-drivers:renesas:adp5589 [24 Jan 2021 17:36] (current) – Fix bad links Dragos Bogdan | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== ADP5589 - Microcontroller | + | ====== ADP5589 - No-OS Driver |
- | + | {{page>: | |
- | ===== Supported Devices ===== | + | |
- | * [[adi> | + | |
- | + | ||
- | ===== Evaluation Boards ===== | + | |
- | * [[http:// | + | |
- | + | ||
- | ===== Overview ===== | + | |
- | + | ||
- | The [[adi> | + | |
- | + | ||
- | I/O expanders can be used to increase the number of I/Os available to a processor or to reduce the number of I/Os required through interface connectors for front panel designs. | + | |
- | + | ||
- | {{ : | + | |
- | + | ||
- | The goal of this project (Microcontroller No-OS) is to be able to provide reference projects for lower end processors, which can't run Linux, or aren't running a specific operating system, to help those customers using microcontrollers with ADI parts. Here you can find a generic driver which can be used as a base for any microcontroller platform and also specific drivers for Renesas platforms. | + | |
**HW Platform(s): | **HW Platform(s): | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
- | * [[http:// | + | ===== Downloads ===== |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | ===== Driver Description ===== | + | < |
- | The driver contains two parts: | + | * {{: |
- | * The driver for the ADP5589 part, which may be used, without modifications, | + | |
- | * The Communication Driver, where the specific communication functions for the desired type of processor and communication protocol have to be implemented. This driver implements the communication with the device and hides the actual details of the communication protocol to the ADI driver. | + | |
- | + | ||
- | The Communication Driver has a standard interface, so the ADP5589 driver can be used exactly as it is provided. | + | |
- | + | ||
- | There are three functions which are called by the ADP5589 driver: | + | |
- | * I2C_Init() – initializes the communication peripheral. | + | |
- | * I2C_Write() – writes data to the device. | + | |
- | * I2C_Read() – reads data from the device. | + | |
- | + | ||
- | {{ : | + | |
- | < | + | |
- | I2C driver architecture | + | |
- | </ | + | |
- | + | ||
- | The implementation of these three functions depends on the used microcontroller. | + | |
- | + | ||
- | The following functions are implemented in this version of ADP5589 driver: | + | |
- | ^ Function | + | |
- | | void ADP5589_SetRegisterValue(unsigned char registerAddress, | + | |
- | | unsigned char ADP5589_GetRegisterValue(unsigned char registerAddress) | Reads the value of a register. | | + | |
- | | unsigned char ADP5589_Init(void) | Initializes the communication peripheral and checks if the ADP5589 part is present. | | + | |
- | | void ADP5589_InitPwm(void) | Initializes the PWM generator in continuous mode. | | + | |
- | | void ADP5589_SetPwm(unsigned short pwmOffTime, unsigned short pwmOnTime) | Sets the PWM On and Off times. | | + | |
- | | void ADP5589_GpioDirection(unsigned char reg, unsigned char val) | Sets the direction of the pins. | | + | |
- | | unsigned char ADP5589_GetPinState(unsigned char reg) | Reads the state of the pins. | | + | |
- | | void ADP5589_SetPinState(unsigned char reg, unsigned char state) | Sets the state of the pins. | | + | |
- | | void ADP5589_InitKey(unsigned char pmodPort) | Initializes keyboard decoder. | | + | |
- | | unsigned char ADP5589_KeyDecode(unsigned char reg, unsigned char pmodPort) | Decodes the key pressed on the Pmod-KYPD. | | + | |
- | | void ADP5589_KeyLock(unsigned char pmodPort) | Locks the ADP5589 and requests Password for unlock. | | + | |
- | + | ||
- | ===== Downloads ===== | + | |
- | * {{: | + | |
* {{: | * {{: | ||
* {{: | * {{: | ||
- | * {{:resources:tools-software: | + | * **ADP5589 Driver: ** https:// |
- | * {{:resources:tools-software: | + | * **PmodIOXP Demo for RL78G14: ** https://github.com/ |
+ | * **RL78G14 Common Drivers: ** https://github.com/ | ||
+ | </ | ||
====== Renesas RL78G13 Quick Start Guide ====== | ====== Renesas RL78G13 Quick Start Guide ====== | ||
Line 69: | Line 21: | ||
==== Required Hardware ==== | ==== Required Hardware ==== | ||
- | * [[http://am.renesas.com/ | + | * [[https://www.renesas.com/ |
* [[http:// | * [[http:// | ||
* [[http:// | * [[http:// | ||
Line 75: | Line 27: | ||
==== Required Software ==== | ==== Required Software ==== | ||
* [[http:// | * [[http:// | ||
- | * [[http:// | ||
==== Hardware Setup ==== | ==== Hardware Setup ==== | ||
Line 87: | Line 38: | ||
{{ : | {{ : | ||
- | ==== Software Setup ==== | + | ==== Reference Project Overview |
- | With the //**Applilet3 | + | The reference project: |
+ | | ||
+ | |||
+ | {{ : | ||
- | === CSI10 (Clocked Serial Interface 10) – For the ST7579 | + | * after the keypad is unlocked, it will display on the LCD the last pressed key and the status |
- | Choose to generate | + | |
- | * Transfer mode setting: //**Single transfer mode**// | + | |
- | * Data length setting : //**8 bits**// | + | |
- | * Transfer direction setting: // | + | |
- | * Specification | + | |
- | * Transfer rate setting – Clock mode: // | + | |
- | * Transfer rate setting – Baudrate: // | + | |
- | * Interrupt setting – Transfer interrupt priority (INTCSI10): // | + | |
- | * Uncheck | + | |
- | === IICA0 (Inter Integrated Circuit Bus) - For the ADP5589 part === | + | {{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13_screen_2.jpg? |}} |
- | Choose the //**Single master**// transfer mode and configure the interface with the following settings: | + | |
- | * Clock mode setting: // | + | |
- | * Local address setting – Address: // | + | |
- | * Operation mode setting : // | + | |
- | * Operation mode setting – Transfer clock (fSCL): // | + | |
- | * Interrupt setting – Communication end interrupt priority (INTIICA0): // | + | |
- | * Callback function setting: Check //**Master transmission end**// and //**Master reception end**// callback functions | + | |
- | * Callback function enhanced feature setting: Check the // | + | |
- | === TM00 (Timer 00) – For the DelayMs() function | + | ==== Software Project Tutorial ==== |
- | Configure TM00 as an interval timer: | + | {{page> |
- | * Interval timer setting | + | |
- | * Interval timer setting - Uncheck | + | ====== Renesas RL78G14 Quick Start Guide ====== |
- | * Interrupt setting - Uncheck | + | This section contains a description of the steps required to run the ADP5589 demonstration project on a Renesas RL78G14 platform using the PmodIOXP. |
+ | |||
+ | ==== Required Hardware ==== | ||
+ | * [[https:// | ||
+ | * [[http://www.digilentinc.com/Products/Detail.cfm? | ||
+ | * [[http://www.digilentinc.com/Products/Detail.cfm? | ||
+ | |||
+ | ==== Required Software ==== | ||
+ | * [[http://www.iar.com/en/Products/ | ||
+ | * The ADP5589 demonstration project for the Renesas RL78G14 platform. | ||
- | === Watchdog Timer === | + | <WRAP round info 80%> |
- | Disable | + | The ADP5589 demonstration project for the Renesas RL78G14 platform consists of three parts: the **ADP5589 Driver**, |
- | | + | |
+ | All three parts have to be downloaded. | ||
+ | </WRAP> | ||
+ | |||
+ | ==== Hardware Setup ==== | ||
+ | A PmodIOXP has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G14: | ||
+ | |||
+ | PmodIOXP J3 connector 1 (SCL) → RDKRL78G14 J8 connector Pin 1 | ||
+ | PmodIOXP J3 connector 3 (SDA) → RDKRL78G14 J8 connector Pin 3 | ||
+ | PmodIOXP J3 connector 5 (GND) → RDKRL78G14 J11 connector Pin 5 | ||
+ | PmodIOXP J3 connector 7 (VCC) → RDKRL78G14 J11 connector Pin 6 | ||
+ | |||
+ | {{ : | ||
==== Reference Project Overview ==== | ==== Reference Project Overview ==== | ||
- | The reference project waits for a password to unlock the keypad. | + | The reference project: |
+ | * waits for a password to unlock the keypad; | ||
+ | |||
+ | {{ : | ||
- | {{ : | + | * after the keypad is unlocked, it will display on the LCD the last pressed and released key(which can be different keys) and the status of R0 pin; also the PWM generator is enabled on pin R3. |
- | After the keypad is unlocked the state of the pin R0 and the key presses are displayed on the LCD. Also the PWM generator is enabled on pin R3. | + | {{ : |
- | {{ : | ||
==== Software Project Tutorial ==== | ==== Software Project Tutorial ==== | ||
- | {{page>rl78g13_software_tutorial}} | + | {{page>rl78g14_software_tutorial}} |
+ | |||
====== Renesas RX62N Quick Start Guide ====== | ====== Renesas RX62N Quick Start Guide ====== | ||
Line 137: | Line 99: | ||
==== Required Hardware ==== | ==== Required Hardware ==== | ||
- | * [[http://am.renesas.com/ | + | * [[https://www.renesas.com/ |
* [[http:// | * [[http:// | ||
* [[http:// | * [[http:// | ||
==== Required Software ==== | ==== Required Software ==== | ||
- | * [[http:// | + | * [[https:// |
- | * [[http://am.renesas.com/ | + | * [[https://www.renesas.com/ |
==== Hardware Setup ==== | ==== Hardware Setup ==== | ||
Line 165: | Line 127: | ||
==== Software Project Setup ==== | ==== Software Project Setup ==== | ||
{{page> | {{page> | ||
- | |||
- | ====== Digilent Cerebot MX3cK Quick Start Guide ====== | ||
- | This section contains a description of the steps required to run the ADP5589 demonstration project on a Digilent Cerebot MX3cK platform. | ||
- | |||
- | ==== Required Hardware ==== | ||
- | * [[http:// | ||
- | * [[http:// | ||
- | |||
- | ==== Required Software ==== | ||
- | * [[http:// | ||
- | * [[http:// | ||
- | |||
- | ==== Hardware Setup ==== | ||
- | A PmodIOXP has to be connected to the J2 connector of Cerebot MX3cK development board. | ||
- | |||
- | {{ : | ||
- | |||
- | ==== Reference Project Overview ==== | ||
- | Following commands were implemented in this version of ADP5589 reference project for Cerebot MX3cK board. | ||
- | ^ Command ^ Description ^ | ||
- | | help? | Displays all available commands. | | ||
- | | pwmOnTime= | On time of the PWM pulse. Accepted values: 0 - 65535 | | ||
- | | pwmOffTime= | Off time of the PWM pulse. Accepted values: 0 - 65535 | | ||
- | | lastKey? | Displays the last key which was pressed | | ||
- | Commands can be executed using a serial terminal connected to the UART1 peripheral of PIC32MX320F128H. | ||
- | |||
- | The following image shows a list of commands in a serial terminal connected to processor’s UART peripheral. | ||
- | {{ : | ||
- | |||
- | ==== Software Project Setup ==== | ||
- | {{page>: | ||
- | |||
- | ====== Digilent Cerebot MC7 Quick Start Guide ====== | ||
- | This section contains a description of the steps required to run the ADP5589 demonstration project on a Digilent Cerebot MC7 platform. | ||
- | |||
- | ==== Required Hardware ==== | ||
- | * [[http:// | ||
- | * [[http:// | ||
- | |||
- | ==== Required Software ==== | ||
- | * [[http:// | ||
- | * [[http:// | ||
- | |||
- | ==== Hardware Setup ==== | ||
- | A PmodIOXP has to be connected to the J6 connector of Cerebot MC7 development board. | ||
- | |||
- | {{ : | ||
- | |||
- | ==== Reference Project Overview ==== | ||
- | Following commands were implemented in this version of ADP5589 reference project for Cerebot MC7 board. | ||
- | ^ Command ^ Description ^ | ||
- | | help? | Displays all available commands. | | ||
- | | pwmOnTime= | On time of the PWM pulse. Accepted values: 0 - 65535 | | ||
- | | pwmOffTime= | Off time of the PWM pulse. Accepted values: 0 - 65535 | | ||
- | | lastKey? | Displays the last key which was pressed | | ||
- | Commands can be executed using a serial terminal connected to the UART1 peripheral of dsPIC33FJ128MC706A. | ||
- | |||
- | The following image shows a list of commands in a serial terminal connected to processor’s UART peripheral. | ||
- | {{ : | ||
- | |||
- | ==== Software Project Setup ==== | ||
- | {{page>: | ||
====== More information ====== | ====== More information ====== | ||
- | {{page> | + | {{page>: |