GPIO Service Module

This module provides a Service that will configure, read and write the general purpose IO pins on your SOMANET device. A client could retrieve data from the Service through interfaces. This Service is very useful for certain applications, such as Motor Control over a communication protocol (e.g. EtherCAT).

When running the Hall Service, the Reference Frequency of the tile where the Service is allocated will be automatically changed to 250MHz.

The GPIO Service should always run over an IF2 Tile so it can access the ports to your SOMANET Drive module.

How to use

Important

We assume that you are using SOMANET Base and your app includes the required board support files for your SOMANET device.

  1. First, add all the SOMANET Motor Control Library modules to your app Makefile.

    USED_MODULES = module_gpio module_hall_sensor module_pwm module_adc module_controllers module_utils lib_bldc_torque_control module_profiles module_incremenatal_encoder module_watchdog module_board-support
    

    Note

    Not all modules will be required, but when using a library it is recommended to include always all the contained modules. This will help solving internal dependency issues.

  2. Include the GPIO Service header gpio_service.h in your app.

  3. Instantiate the ports where the Service will be accessing the GPIO pins.

  4. Inside your main function, instantiate the interfaces array for the Service-Clients communication.

  5. At your IF2 tile, instantiate the Service.

  6. At whichever other core, now you can perform calls to the GPIO Service through the interfaces connected to it.

    #include <CoreC2X.bsp>                          //Board Support file for SOMANET Core C2X device
    #include <Drive1000-rev-c4.bsp>     //Board Support file for SOMANET Drive module
                                        //(select your board support files according to your device)
    
    #include <gpio_service.h> // 2
    
    port gpio_ports[4] = {  SOMANET_DRIVE_GPIO_D0,
                            SOMANET_DRIVE_GPIO_D1,
                            SOMANET_DRIVE_GPIO_D2,
                            SOMANET_DRIVE_GPIO_D3 }; // 3
    int main(void)
    {
    
        interface GPIOInterface i_gpio[1]; // 4
    
        par
        {
            on tile[APP_TILE]:
            {
                    i_gpio[0].config_dio_done(); // 6
                    int foo = i_gpio[0].read_gpio(0);
            }
    
            on tile[IF2_TILE]: gpio_service(gpio_ports, i_gpio); // 5
        }
    
        return 0;
    }
    

API

Types

SwitchType

Type definition for port configuration.

Enum Values:

ACTIVE_HIGH
ACTIVE_LOW

Service

[[combinable]] void gpio_service(port gpio_ports[4], interface GPIOInterface server i_gpio[1])

Service to manage the digital I/Os in your SOMANET device.

Parameters:
  • gpio_ports – Array of ports to be managed.
  • i_gpio – Array of communication interfaces to handle one client.

Interface

interface GPIOInterface

Interface type to communicate with the GPIO Service.

int config_dio_input(int gpio_port, int input_type, SwitchType switch_type)

Set the configuration of the GPIOs.

By default all GPIOs are configured as outputs.

Parameters:
  • gpio_port – Number of the pin to be configured [0:3].
  • input_type – Type of input [GP_INPUT_TYPE, SWITCH_INPUT_TYPE].
  • switch_type – [ACTIVE_HIGH, ACTIVE_LOW].
Returns:

0 - Error 1 - Success

void config_dio_done()

Disables further configuration of any GPIO.

Required before starting reading or writing values.

int read_gpio(int gpio_port)

Read the current value in a GPIO pin.

Parameters:
  • gpio_port – Number of the pin to read [0:3].
Returns:

Read value in the port [0,1].

void write_gpio(int gpio_port, int value)

Set a value in certain GPIO.

Parameters:
  • gpio_port – Number of the pin to write to [0:3].
  • value – Output value for the pin [0,1].