Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
resources:tools-software:uc-drivers:microchip:adp5589 [28 Sep 2012 12:42] – created Andrei Cozmaresources:tools-software:uc-drivers:microchip:adp5589 [22 Jul 2019 14:18] (current) – Update no-OS driver link Andrei Drimbarean
Line 1: Line 1:
-====== ADP5589 - Microcontroller No-OS Driver ====== +====== ADP5589 - No-OS Driver for Microchip Microcontroller Platforms ====== 
- +{{page>:resources:tools-software:uc-drivers:adp5589}}
-===== Supported Devices ===== +
-  * [[adi>ADP5589]] +
- +
-===== Evaluation Boards ===== +
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]] +
- +
-===== Overview ===== +
- +
-The [[adi>ADP5589]] a 19 channel GPIO (General Purpose Input/Output) port expander with built-in keypad matrix decoder, programmable logic, reset logic, and PWM generator. The IC is capable of handling QWERTY size keyboards and GPIO expansion. I/O expander ICs are used in portable devices (phones, remote controls, & cameras) and non-portable applications (healthcare, industrial & instrumentation). +
- +
-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. +
- +
-{{ :resources:tools-software:uc-drivers:renesas:pmod_ioxp.jpg? |}} +
- +
-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):**
- +  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MX3CK|Digilent Cerebot MX3cK (Digilent)]]
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrl78g13/index.jsp|Renesas Demo Kit for RL78G13 (Renesas)]] +
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrx62n/index.jsp|Renesas Demo Kit for RX62N (Renesas)]] +
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MX3CK|Cerebot MX3cK (Digilent)]]+
   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MC7|Cerebot MC7 (Digilent)]]   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MC7|Cerebot MC7 (Digilent)]]
- 
-===== Driver Description ===== 
-The driver contains two parts: 
-  * The driver for the ADP5589 part, which may be used, without modifications, with any microcontroller. 
-  * 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. 
- 
-{{ :resources:tools-software:uc-drivers:renesas:i2c_architecture.png? |}} 
-<WRAP centeralign> 
-I2C driver architecture 
-</WRAP> 
- 
-The implementation of these three functions depends on the used microcontroller.  
- 
-The following functions are implemented in this version of ADP5589 driver: 
-^ Function       ^ Description     ^ 
-| void ADP5589_SetRegisterValue(unsigned char registerAddress, unsigned char registerValue) | Writes data into a register. | 
-| 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 ===== ===== Downloads =====
-  * {{:resources:tools-software:uc-drivers:renesas:adp5589_generic.zip|ADP5589 Generic Driver}} +<WRAP round download 80%>
-  * {{:resources:tools-software:uc-drivers:microchip:adp5589_pic32.zip|ADP5589 PIC32 Driver}}+
   * {{:resources:tools-software:uc-drivers:microchip:adp5589_dspic33.zip|ADP5589 DSPIC33 Driver}}   * {{:resources:tools-software:uc-drivers:microchip:adp5589_dspic33.zip|ADP5589 DSPIC33 Driver}}
 +  * **ADP5589 Driver:           ** https://github.com/analogdevicesinc/no-OS/tree/master/drivers/io-expander/adp5589
 +  * **PmodIOXP Demo for PIC32MX320F128H: ** https://github.com/analogdevicesinc/no-OS/tree/master/Microchip/PIC32MX320F128H/PmodIOXP
 +  * **PIC32MX320F128H Common Drivers:   ** https://github.com/analogdevicesinc/no-OS/tree/master/Microchip/PIC32MX320F128H/Common
 +</WRAP>
  
 ====== Digilent Cerebot MX3cK Quick Start Guide ====== ====== Digilent Cerebot MX3cK Quick Start Guide ======
Line 72: Line 24:
   * [[http://www.microchip.com/mplabx|MPLAB X Integrated Development Environment]]   * [[http://www.microchip.com/mplabx|MPLAB X Integrated Development Environment]]
   * [[http://www.microchip.com/mplabxc|MPLAB XC32 compiler]]   * [[http://www.microchip.com/mplabxc|MPLAB XC32 compiler]]
 +  * The ADP5589 demonstration project for PIC32MX320F128H.
 +
 +<WRAP round info 80%>
 +The ADP5589 demonstration project for PIC32MX320F128H consists of three parts: the **ADP5589 Driver**,  the **PmodIOXP Demo for PIC32MX320F128H** and the **PIC32MX320F128H Common Drivers**.
 +
 +All three parts have to be downloaded.
 +</WRAP>
  
 ==== Hardware Setup ==== ==== Hardware Setup ====
-A PmodIOXP has to be connected to the J2 connector of Cerebot MX3cK development board.+A PmodIOXP has to be connected to the J2 connector of Cerebot MX3cK development board. For this demonstration project, PmodKYPD must be connected to J2 connector of PmodIOXP, because the PWM signal is mapped on J1 connector, pin 4.
  
 {{ :resources:tools-software:uc-drivers:microchip:pmod_ioxp_pic32.jpg? |}} {{ :resources:tools-software:uc-drivers:microchip:pmod_ioxp_pic32.jpg? |}}
  
 ==== Reference Project Overview ==== ==== Reference Project Overview ====
-Following commands were implemented in this version of ADP5589 reference project for Cerebot MX3cK board.+The following commands were implemented in this version of ADP5589 reference project for Cerebot MX3cK board.
 ^ Command ^ Description ^ ^ Command ^ Description ^
 | help? | Displays all available commands. | | help? | Displays all available commands. |
-| pwmOnTime= | On time of the PWM pulse. Accepted values: 0 - 65535 | +| pwmOnTime= | On time of the PWM pulse. Accepted values:\\ 1 .. 65535[us] - time when the signal is high. 
-| pwmOffTime= | Off time of the PWM pulse. Accepted values: 0 - 65535 | +| pwmOffTime= | Off time of the PWM pulse. Accepted values:\\ 1 .. 65535[us] - time when the signal is low. 
-lastKey? | Displays the last key which was pressed |+keyPressed? | Displays the last key which was pressed. | 
 +| keyReleased? | Displays the last key which was released. |
 Commands can be executed using a serial terminal connected to the UART1 peripheral of PIC32MX320F128H. 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.+The following image shows a generic list of commands in a serial terminal connected to processor’s UART peripheral.
 {{ :resources:tools-software:uc-drivers:microchip:terminal_pic32.png? |}} {{ :resources:tools-software:uc-drivers:microchip:terminal_pic32.png? |}}
- 
 ==== Software Project Setup ==== ==== Software Project Setup ====
 {{page>:resources:tools-software:uc-drivers:microchip:pic32_software_design}} {{page>:resources:tools-software:uc-drivers:microchip:pic32_software_design}}
Line 125: Line 84:
  
 ====== More information ====== ====== More information ======
-{{page>more-information}}+{{page>:resources:tools-software:uc-drivers:more-information}}
resources/tools-software/uc-drivers/microchip/adp5589.1348828966.txt.gz · Last modified: 28 Sep 2012 12:42 by Andrei Cozma