SSD1306 OLED display driver 1.8.2 This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays

io.h
Go to the documentation of this file.
1 /*
2 MIT License
3
4 Copyright (c) 2018, Alexey Dynda
5
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24
29 #ifndef _SSD1306_HAL_IO_H_
30 #define _SSD1306_HAL_IO_H_
31
41 #include "UserSettings.h"
42 #if defined(ARDUINO)
43 #include "arduino/io.h"
44 #elif defined(__AVR__) && !defined(ARDUINO)
45 #include "avr/io.h"
46 #elif defined(__XTENSA__) && !defined(ARDUINO)
47 #include "esp/io.h"
48 #elif defined(STM32F1) || defined(STM32F2) || defined(STM32F4)
49 #include "stm32/io.h"
50 #elif defined(__linux__)
51 #include "linux/io.h"
52 #elif defined(__MINGW32__)
53 #include "mingw/io.h"
54 #else
55 #warning "Platform is not supported. Use template to add support"
56 #include "template/io.h"
57 #endif
58
59 #ifndef LCDINT_TYPES_DEFINED
60
61 #define LCDINT_TYPES_DEFINED
62
63 typedef int lcdint_t;
65 typedef unsigned int lcduint_t;
66 #endif
67
69 #define ssd1306_swap_data(a, b, type) { type t = a; a = b; b = t; }
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75 // !!! PLATFORM I2C IMPLEMENTATION OPTIONAL !!!
76 #if defined(CONFIG_PLATFORM_I2C_AVAILABLE) && defined(CONFIG_PLATFORM_I2C_ENABLE)
77
80 typedef struct {
81 int8_t sda;
82 int8_t scl;
83 } ssd1306_platform_i2cConfig_t;
84
99 void ssd1306_platform_i2cInit(int8_t busId, uint8_t addr, ssd1306_platform_i2cConfig_t * cfg);
100 #endif
101
102
103 // !!! PLATFORM SPI IMPLEMENTATION OPTIONAL !!!
104 #if defined(CONFIG_PLATFORM_SPI_AVAILABLE) && defined(CONFIG_PLATFORM_SPI_ENABLE)
105
121 void ssd1306_platform_spiInit(int8_t busId, int8_t cesPin, int8_t dcPin);
122 #endif
123
124 #ifdef __cplusplus
125 }
126 #endif
127
132 #endif
133
134
ssd1306_platform_i2cConfig_t::scl
int8_t scl
clock pin number
Definition: io.h:82
ssd1306_platform_i2cConfig_t
Definition: io.h:80
ssd1306_platform_spiInit
void ssd1306_platform_spiInit(int8_t busId, int8_t cesPin, int8_t dcPin)
Initializes spi interface for platform being used.
lcdint_t
int lcdint_t
Definition: io.h:63
lcduint_t
unsigned int lcduint_t
Definition: io.h:65
ssd1306_platform_i2cInit
void ssd1306_platform_i2cInit(int8_t busId, uint8_t addr, ssd1306_platform_i2cConfig_t *cfg)
Initializes i2c interface for platform being used.
UserSettings.h
ssd1306_platform_i2cConfig_t::sda
int8_t sda
data pin number
Definition: io.h:81