rpi_gpio 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 86ea9cc97cf1ad0545d3d3b6cdd1e67e9fb2bcf6
-  data.tar.gz: e03a4eebed31cc7dc53c946a3fb12fde1a4281b9
+SHA256:
+  metadata.gz: cf2e5fe321ddea6602db36bf081dcdd9b16d1248a584c9fe2156cf3b1cc8764b
+  data.tar.gz: aea0df6d2ce23b6b60ffdd35a1a856c09920fda38dfdcc197f4d38b417129935
 SHA512:
-  metadata.gz: 1a6552df0cc6cbf3e7d24d2c9f5affd7f4940b59e7de1ba1dee4bb60e1a12fb4f2bc2bad79db7e22db1782327f01b6fb6926930a814f206d659a31e15a4f1a76
-  data.tar.gz: 8d3853451e5e8d6aab73756b65530b0d352fd79c14d10b732768ee52e64e37561dd565a16d3442f4dd3000c8163b895649024b7a4ee8c63fee25bef85222a89e
+  metadata.gz: e2d50e340b0d24349c291b4927fa4bc03e3c477862659a4b6a4f81c5a6c10a94e612e70acef98299627fc299f53cad68f15606b9795b610af1e82d559face6d3
+  data.tar.gz: f6495cbea95ddfe0348bd9be92d716d4929329414ef49d6d6649a373f87af4a62346d1fe74631771de24a066b3b7bfcb1335efda76bda8dbd934e5d1eab644de

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    rpi_gpio (0.3.3)
+    rpi_gpio (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    rake (12.0.0)
-    rake-compiler (1.0.3)
+    diff-lcs (1.4.4)
+    rake (13.0.1)
+    rake-compiler (1.1.1)
       rake
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
@@ -31,3 +31,6 @@ DEPENDENCIES
   rake-compiler
   rpi_gpio!
   rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Nick Lowery
-Copyright (c) 2013-2014 Ben Croston
+Copyright (c) 2014-2020 Nick Lowery
+Copyright (c) 2012-2014 Ben Croston
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -20,4 +20,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

data/README.md

@@ -1,145 +1,145 @@
-# rpi_gpio v0.3.3
-
-Ruby conversion of [RPi.GPIO Python module](https://pypi.python.org/pypi/RPi.GPIO)
-
-## Features
-
-Manipulate your Raspberry Pi's GPIO pins from Ruby!
-
-- Boolean input/output
-- Software-driven PWM (written in C for speed)
-
-Up-to-date with RPi.GPIO Python module version 0.6.3, so it works on all Raspberry Pi models!
-
-## Sample Usage
-
-I aimed to make the gem's usage exactly the same as its Python counterpart -- only with a few semantic differences to utilize Ruby's readability. If anything is confusing, you can always check [here](http://sourceforge.net/p/raspberry-gpio-python/wiki/Examples/) for the original Python module's documentation.
-
-#### Download the gem
-
-The easiest way to download the gem is to use [Bundler](http://bundler.io/) with a Gemfile. In your Gemfile, include the line 
-```ruby
-gem 'rpi_gpio'
-```
-Then you can run `bundle install` to automatically download and compile the gem for your system. To include the gem in a Ruby file, use the line `require 'rpi_gpio'`.
-
-#### Pin numbering
-
-Before you can do anything with the GPIO pins, you need to specify how you want to number them.
-```ruby
-RPi::GPIO.set_numbering :board
-# or
-RPi::GPIO.set_numbering :bcm
-````
-`:board` numbering refers to the physical pin numbers on the Pi, whereas `:bcm` numbering refers to the Broadcom SOC channel numbering. Note that `:bcm` numbering differs between Pi models, while `:board` numbering does not.
-
-#### Input
-
-To receive input from a GPIO pin, you must first initialize it as an input pin:
-```ruby
-RPi::GPIO.setup PIN_NUM, :as => :input
-```
-The pin number will differ based on your selected numbering system and which pin you want to use.
-
-Now you can use the calls
-```ruby
-RPi::GPIO.high? PIN_NUM
-RPi::GPIO.low? PIN_NUM
-```
-to receive either `true` or `false`.
-
-You can use the additional hash argument `:pull` to apply a pull-up or pull-down resistor to the input pin like so:
-```ruby
-RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :down
-# or
-RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :up
-# or (not necessary; :off is the default value)
-RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :off
-```
-
-#### Output
-
-To send output to a GPIO pin, you must first initialize it as an output pin:
-```ruby
-RPi::GPIO.setup PIN_NUM, :as => :output
-```
-Now you can use the calls
-```ruby
-RPi::GPIO.set_high PIN_NUM
-RPi::GPIO.set_low PIN_NUM
-```
-to set the pin either high or low.
-
-You can use the additional hash argument `:initialize` to set the pin's initial state like so:
-```ruby
-RPi::GPIO.setup PIN_NUM, :as => :output, :initialize => :high
-# or
-RPi::GPIO.setup PIN_NUM, :as => :output, :initialize => :low
-```
-
-#### PWM (pulse-width modulation)
-
-Pulse-width modulation is a useful tool for controlling things like LED brightness or motor speed. To utilize PWM, first create a PWM object for an [output pin](#output).
-```ruby
-pwm = RPi::GPIO::PWM.new(PIN_NUM, PWM_FREQ)
-```
-The `PWM_FREQ` is a value in hertz that specifies the amount of pulse cycles per second.
-
-Now you can call the following method to start PWM:
-```ruby
-pwm.start DUTY_CYCLE
-```
-`DUTY_CYCLE` is a value from `0.0` to `100.0` indicating the percent of the time that the signal will be high.
-
-Once running, you can get/set the PWM duty cycle with
-```ruby
-pwm.duty_cycle # get
-pwm.duty_cycle = NEW_DUTY_CYCLE # set
-```
-get/set the PWM frequency with
-```ruby
-pwm.frequency # get
-pwm.frequency = NEW_FREQUENCY # set
-```
-and get the PWM GPIO number with
-```ruby
-pwm.gpio
-```
-Note that this number corresponds to `:bcm` numbering of the GPIO pins, so it will be different than pin number you used if you created the PWM with `:board` numbering.
-
-To stop PWM, use
-```ruby
-pwm.stop
-```
-
-To check if a PWM object is currently running, use
-```ruby
-pwm.running?
-```
-
-#### Cleaning up
-
-After your program is finished using the GPIO pins, it's a good idea to release them so other programs can use them later. Simply call
-```ruby
-RPi::GPIO.clean_up PIN_NUM
-```
-to release a specific pin, or
-```ruby
-RPi::GPIO.clean_up
-```
-to release all allocated pins.
-
-Alternatively, you can call
-```ruby
-RPi::GPIO.reset
-```
-to clean up all pins and to also reset the selected numbering mode.
-
-## Credits
-
-Original Python code by Ben Croston modified for Ruby by Nick Lowery
-
-Copyright (c) 2014-2015 [Nick Lowery](https://github.com/ClockVapor)
-
-View LICENSE for full license.
-
+# rpi_gpio v0.4.0
+
+Ruby conversion of [RPi.GPIO Python module](https://pypi.python.org/pypi/RPi.GPIO)
+
+## Features
+
+Manipulate your Raspberry Pi's GPIO pins from Ruby!
+
+- Boolean input/output
+- Software-driven PWM (written in C for speed)
+
+Up-to-date with RPi.GPIO Python module version 0.7.0, so it works on all Raspberry Pi models!
+
+## Sample Usage
+
+I aimed to make the gem's usage exactly the same as its Python counterpart -- only with a few semantic differences to utilize Ruby's readability. If anything is confusing, you can always check [here](http://sourceforge.net/p/raspberry-gpio-python/wiki/Examples/) for the original Python module's documentation.
+
+#### Download the gem
+
+The easiest way to download the gem is to use [Bundler](http://bundler.io/) with a Gemfile. In your Gemfile, include the line 
+```ruby
+gem 'rpi_gpio'
+```
+Then you can run `bundle install` to automatically download and compile the gem for your system. To include the gem in a Ruby file, use the line `require 'rpi_gpio'`.
+
+#### Pin numbering
+
+Before you can do anything with the GPIO pins, you need to specify how you want to number them.
+```ruby
+RPi::GPIO.set_numbering :board
+# or
+RPi::GPIO.set_numbering :bcm
+````
+`:board` numbering refers to the physical pin numbers on the Pi, whereas `:bcm` numbering refers to the Broadcom SOC channel numbering. Note that `:bcm` numbering differs between Pi models, while `:board` numbering does not.
+
+#### Input
+
+To receive input from a GPIO pin, you must first initialize it as an input pin:
+```ruby
+RPi::GPIO.setup PIN_NUM, :as => :input
+```
+The pin number will differ based on your selected numbering system and which pin you want to use.
+
+Now you can use the calls
+```ruby
+RPi::GPIO.high? PIN_NUM
+RPi::GPIO.low? PIN_NUM
+```
+to receive either `true` or `false`.
+
+You can use the additional hash argument `:pull` to apply a pull-up or pull-down resistor to the input pin like so:
+```ruby
+RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :down
+# or
+RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :up
+# or (not necessary; :off is the default value)
+RPi::GPIO.setup PIN_NUM, :as => :input, :pull => :off
+```
+
+#### Output
+
+To send output to a GPIO pin, you must first initialize it as an output pin:
+```ruby
+RPi::GPIO.setup PIN_NUM, :as => :output
+```
+Now you can use the calls
+```ruby
+RPi::GPIO.set_high PIN_NUM
+RPi::GPIO.set_low PIN_NUM
+```
+to set the pin either high or low.
+
+You can use the additional hash argument `:initialize` to set the pin's initial state like so:
+```ruby
+RPi::GPIO.setup PIN_NUM, :as => :output, :initialize => :high
+# or
+RPi::GPIO.setup PIN_NUM, :as => :output, :initialize => :low
+```
+
+#### PWM (pulse-width modulation)
+
+Pulse-width modulation is a useful tool for controlling things like LED brightness or motor speed. To utilize PWM, first create a PWM object for an [output pin](#output).
+```ruby
+pwm = RPi::GPIO::PWM.new(PIN_NUM, PWM_FREQ)
+```
+The `PWM_FREQ` is a value in hertz that specifies the amount of pulse cycles per second.
+
+Now you can call the following method to start PWM:
+```ruby
+pwm.start DUTY_CYCLE
+```
+`DUTY_CYCLE` is a value from `0.0` to `100.0` indicating the percent of the time that the signal will be high.
+
+Once running, you can get/set the PWM duty cycle with
+```ruby
+pwm.duty_cycle # get
+pwm.duty_cycle = NEW_DUTY_CYCLE # set
+```
+get/set the PWM frequency with
+```ruby
+pwm.frequency # get
+pwm.frequency = NEW_FREQUENCY # set
+```
+and get the PWM GPIO number with
+```ruby
+pwm.gpio
+```
+Note that this number corresponds to `:bcm` numbering of the GPIO pins, so it will be different than pin number you used if you created the PWM with `:board` numbering.
+
+To stop PWM, use
+```ruby
+pwm.stop
+```
+
+To check if a PWM object is currently running, use
+```ruby
+pwm.running?
+```
+
+#### Cleaning up
+
+After your program is finished using the GPIO pins, it's a good idea to release them so other programs can use them later. Simply call
+```ruby
+RPi::GPIO.clean_up PIN_NUM
+```
+to release a specific pin, or
+```ruby
+RPi::GPIO.clean_up
+```
+to release all allocated pins.
+
+Alternatively, you can call
+```ruby
+RPi::GPIO.reset
+```
+to clean up all pins and to also reset the selected numbering mode.
+
+## Credits
+
+Original Python code by Ben Croston modified for Ruby by Nick Lowery
+
+Copyright (c) 2014-2020 [Nick Lowery](https://github.com/ClockVapor)
+
+View LICENSE for full license.
+

data/ext/rpi_gpio/c_gpio.c

@@ -1,9 +1,9 @@
 /*
 Original code by Ben Croston modified for Ruby by Nick Lowery
 (github.com/clockvapor)
-Copyright (c) 2014-2016 Nick Lowery
+Copyright (c) 2014-2020 Nick Lowery
 
-Copyright (c) 2013-2015 Ben Croston
+Copyright (c) 2012-2019 Ben Croston
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -47,6 +47,11 @@ SOFTWARE.
 #define PULLUPDN_OFFSET             37  // 0x0094 / 4
 #define PULLUPDNCLK_OFFSET          38  // 0x0098 / 4
 
+#define PULLUPDN_OFFSET_2711_0      57
+#define PULLUPDN_OFFSET_2711_1      58
+#define PULLUPDN_OFFSET_2711_2      59
+#define PULLUPDN_OFFSET_2711_3      60
+
 #define PAGE_SIZE  (4*1024)
 #define BLOCK_SIZE (4*1024)
 
@@ -65,7 +70,7 @@ int setup(void)
 {
     int mem_fd;
     uint8_t *gpio_mem;
-    uint32_t peri_base;
+    uint32_t peri_base = 0;
     uint32_t gpio_base;
     unsigned char buf[4];
     FILE *fp;
@@ -76,8 +81,7 @@ int setup(void)
     // try /dev/gpiomem first - this does not require root privs
     if ((mem_fd = open("/dev/gpiomem", O_RDWR|O_SYNC)) > 0)
     {
-        gpio_map = (uint32_t *)mmap(NULL, BLOCK_SIZE, PROT_READ|PROT_WRITE, MAP_SHARED, mem_fd, 0);
-        if ((uint32_t)gpio_map < 0) {
+        if ((gpio_map = (uint32_t *)mmap(NULL, BLOCK_SIZE, PROT_READ|PROT_WRITE, MAP_SHARED, mem_fd, 0)) == MAP_FAILED) {
             return SETUP_MMAP_FAIL;
         } else {
             return SETUP_OK;
@@ -99,8 +103,7 @@ int setup(void)
         if ((fp = fopen("/proc/cpuinfo", "r")) == NULL)
             return SETUP_CPUINFO_FAIL;
 
-        while(!feof(fp) && !found) {
-            fgets(buffer, sizeof(buffer), fp);
+        while(!feof(fp) && !found && fgets(buffer, sizeof(buffer), fp)) {
             sscanf(buffer, "Hardware	: %s", hardware);
             if (strcmp(hardware, "BCM2708") == 0 || strcmp(hardware, "BCM2835") == 0) {
                 // pi 1 hardware
@@ -117,26 +120,22 @@ int setup(void)
             return SETUP_NOT_RPI_FAIL;
     }
 
+    if (!peri_base)
+        return SETUP_NOT_RPI_FAIL;
     gpio_base = peri_base + GPIO_BASE_OFFSET;
 
     // mmap the GPIO memory registers
-    if ((mem_fd = open("/dev/mem", O_RDWR|O_SYNC) ) < 0) {
+    if ((mem_fd = open("/dev/mem", O_RDWR|O_SYNC) ) < 0)
         return SETUP_DEVMEM_FAIL;
-    }
 
-    if ((gpio_mem = malloc(BLOCK_SIZE + (PAGE_SIZE-1))) == NULL) {
+    if ((gpio_mem = malloc(BLOCK_SIZE + (PAGE_SIZE-1))) == NULL)
         return SETUP_MALLOC_FAIL;
-    }
 
-    if ((uint32_t)gpio_mem % PAGE_SIZE) {
-        gpio_mem += PAGE_SIZE - ((uint32_t) gpio_mem % PAGE_SIZE);
-    }
-
-    gpio_map = (uint32_t *) mmap((void *) gpio_mem, BLOCK_SIZE, PROT_READ|PROT_WRITE, MAP_SHARED|MAP_FIXED, mem_fd, gpio_base);
+    if ((uint32_t)gpio_mem % PAGE_SIZE)
+        gpio_mem += PAGE_SIZE - ((uint32_t)gpio_mem % PAGE_SIZE);
 
-    if ((uint32_t) gpio_map < 0) {
+    if ((gpio_map = (uint32_t *)mmap( (void *)gpio_mem, BLOCK_SIZE, PROT_READ|PROT_WRITE, MAP_SHARED|MAP_FIXED, mem_fd, gpio_base)) == MAP_FAILED)
         return SETUP_MMAP_FAIL;
-    }
 
     return SETUP_OK;
 }
@@ -158,9 +157,8 @@ int eventdetected(int gpio)
     offset = EVENT_DETECT_OFFSET + (gpio/32);
     bit = (1 << (gpio%32));
     value = *(gpio_map+offset) & bit;
-    if (value) {
+    if (value)
         clear_event_detect(gpio);
-	  }
     return value;
 }
 
@@ -169,11 +167,10 @@ void set_rising_event(int gpio, int enable)
     int offset = RISING_ED_OFFSET + (gpio/32);
     int shift = (gpio%32);
 
-    if (enable) {
+    if (enable)
         *(gpio_map+offset) |= 1 << shift;
-    } else {
+    else
         *(gpio_map+offset) &= ~(1 << shift);
-    }
     clear_event_detect(gpio);
 }
 
@@ -196,11 +193,10 @@ void set_high_event(int gpio, int enable)
     int offset = HIGH_DETECT_OFFSET + (gpio/32);
     int shift = (gpio%32);
 
-    if (enable) {
+    if (enable)
         *(gpio_map+offset) |= (1 << shift);
-    } else {
+    else
         *(gpio_map+offset) &= ~(1 << shift);
-	  }
     clear_event_detect(gpio);
 }
 
@@ -209,33 +205,51 @@ void set_low_event(int gpio, int enable)
     int offset = LOW_DETECT_OFFSET + (gpio/32);
     int shift = (gpio%32);
 
-    if (enable) {
+    if (enable)
         *(gpio_map+offset) |= 1 << shift;
-    } else {
+    else
         *(gpio_map+offset) &= ~(1 << shift);
-    }
     clear_event_detect(gpio);
 }
 
 void set_pullupdn(int gpio, int pud)
 {
-    int clk_offset = PULLUPDNCLK_OFFSET + (gpio/32);
-    int shift = (gpio%32);
-
-    if (pud == PUD_DOWN) {
-        *(gpio_map+PULLUPDN_OFFSET) = (*(gpio_map+PULLUPDN_OFFSET) & ~3) | 
-            PUD_DOWN;
-    } else if (pud == PUD_UP) {
-        *(gpio_map+PULLUPDN_OFFSET) = (*(gpio_map+PULLUPDN_OFFSET) & ~3) | PUD_UP;
-    } else {  // pud == PUD_OFF
+    // Check GPIO register
+    int is2711 = *(gpio_map+PULLUPDN_OFFSET_2711_3) != 0x6770696f;
+    if (is2711) {
+        // Pi 4 Pull-up/down method
+        int pullreg = PULLUPDN_OFFSET_2711_0 + (gpio >> 4);
+        int pullshift = (gpio & 0xf) << 1;
+        unsigned int pullbits;
+        unsigned int pull = 0;
+        switch (pud) {
+            case PUD_OFF:  pull = 0; break;
+            case PUD_UP:   pull = 1; break;
+            case PUD_DOWN: pull = 2; break;
+            default:       pull = 0; // switch PUD to OFF for other values
+        }
+        pullbits = *(gpio_map + pullreg);
+        pullbits &= ~(3 << pullshift);
+        pullbits |= (pull << pullshift);
+        *(gpio_map + pullreg) = pullbits;
+    } else {
+        // Legacy Pull-up/down method
+        int clk_offset = PULLUPDNCLK_OFFSET + (gpio/32);
+        int shift = (gpio%32);
+
+        if (pud == PUD_DOWN) {
+            *(gpio_map+PULLUPDN_OFFSET) = (*(gpio_map+PULLUPDN_OFFSET) & ~3) | PUD_DOWN;
+        } else if (pud == PUD_UP) {
+            *(gpio_map+PULLUPDN_OFFSET) = (*(gpio_map+PULLUPDN_OFFSET) & ~3) | PUD_UP;
+        } else  { // pud == PUD_OFF
+            *(gpio_map+PULLUPDN_OFFSET) &= ~3;
+        }
+        short_wait();
+        *(gpio_map+clk_offset) = 1 << shift;
+        short_wait();
         *(gpio_map+PULLUPDN_OFFSET) &= ~3;
+        *(gpio_map+clk_offset) = 0;
     }
-    
-    short_wait();
-    *(gpio_map+clk_offset) = 1 << shift;
-    short_wait();
-    *(gpio_map+PULLUPDN_OFFSET) &= ~3;
-    *(gpio_map+clk_offset) = 0;
 }
 
 void setup_gpio(int gpio, int direction, int pud)
@@ -265,12 +279,11 @@ void output_gpio(int gpio, int value)
 {
     int offset, shift;
 
-    if (value) { // value == HIGH
+    if (value) // value == HIGH
         offset = SET_OFFSET + (gpio/32);
-    } else {       // value == LOW
-        offset = CLR_OFFSET + (gpio/32);
-    }
-    
+    else       // value == LOW
+       offset = CLR_OFFSET + (gpio/32);
+
     shift = (gpio%32);
 
     *(gpio_map+offset) = 1 << shift;
@@ -288,5 +301,5 @@ int input_gpio(int gpio)
 
 void cleanup(void)
 {
-    munmap((void *) gpio_map, BLOCK_SIZE);
+    munmap((void *)gpio_map, BLOCK_SIZE);
 }