st7567.h

Go to the documentation of this file.

// Copyright 2021 IOsetting <iosetting(at)outlook.com>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef __FW_ST7567__
#define __FW_ST7567__
 
#include "fw_hal.h"
 
#define ST7567_MODEL        ST7567_MODEL_ST7567
 
#define ST7567_CS           P35
#define ST7567_MOSI         P34
#define ST7567_SCK          P32
#define ST7567_RES          P37
#define ST7567_DC           P36
#define ST7567_BL           P12
 
// X width
#define ST7567_WIDTH  128
// Y height
#define ST7567_HEIGHT 64
// Display RAM Columns
#define ST7567_COLUMN_EXPAND  4
// Display RAM Pages (8x8bit + 1bit)
#define ST7567_PAGES 8
// X orientation
#define ST7567_X_ORIENT ST7567_SEG_DIRECTION_NORMAL
// Y orientation
#define ST7567_Y_ORIENT ST7567_COM_DIRECTION_NORMAL
 
#define ST7567_MODEL_ST7565                  0
#define ST7567_MODEL_ST7567                  1
 
/* ST7567 commands definitions */
#define ST7567_DISPLAY_OFF                   0xAE /* 0xae: Display OFF (sleep mode), default */
#define ST7567_DISPLAY_ON                    0xAF /* 0xaf: Display ON in normal mode */
 
#define ST7567_SET_START_LINE                0x40 /* 0x40-7f: Set display start line */
#define  ST7567_SET_START_LINE_MASK          0x3f
 
#define ST7567_SET_PAGE_ADDRESS              0xB0 /* 0xb0-b7: Set page start address, 0 - 8 */
#define  ST7567_SET_PAGE_ADDRESS_MASK        0x07
 
#define ST7567_SET_COLUMN_ADDRESS_MSB        0x10 /* 0x10-0x1f: Set 8bit column address - high 4 bits of 0 - 131 */
#define  ST7567_SET_COLUMN_ADDRESS_MSB_MASK  0x0F
 
#define ST7567_SET_COLUMN_ADDRESS_LSB        0x00 /* 0x00-0x0f: Set 8bit column address - low 4 bits of 0 - 131 */
#define  ST7567_SET_COLUMN_ADDRESS_LSB_MASK  0x0F
 
#define ST7567_SEG_DIRECTION_NORMAL          0xA0 /* 0xa0: Column address 0 is mapped to SEG0, default*/
#define ST7567_SEG_DIRECTION_REVERSE         0xA1 /* 0xa1: Column address 83H(131) is mapped to SEG0 */
 
#define ST7567_COM_DIRECTION_NORMAL          0xC0 /* 0xc0: Set COM output direction, normal mode */
#define ST7567_COM_DIRECTION_REVERSE         0xC8 /* 0xc8: Set COM output direction, reverse mode */
 
#define ST7567_INVERSE_DISPLAY_OFF           0xA6 /* 0xa6: Normal display */
#define ST7567_INVERSE_DISPLAY_ON            0xA7 /* 0xa7: Inverse display */
 
#define ST7567_ALL_PIXEL_ON                  0xA5 /* 0xa5: Entire display ON */
#define ST7567_ALL_PIXEL_NORMAL              0xA4 /* 0xa4: Resume to RAM content display */
 
                                                  /* LCD bias set */
#define ST7567_BIAS_1_9                      0xA2 /* 0xa2: Select BIAS setting 1/9 */
#define ST7567_BIAS_1_7                      0xA3 /* 0xa3: Select BIAS setting 1/7 */
 
#define ST7567_READ_MODIFY_WRITE_START       0xE0 /* 0xe0: Enter the Read Modify Write mode */
#define ST7567_READ_MODIFY_WRITE_END         0xEE /* 0xee: Leave the Read Modify Write mode */
 
#define ST7567_RESET                         0xE2 /* 0xe2: Software RESET */
 
#define ST7567_POWER_CONTROL                 0x28
#define ST7567_POWER_CONTROL_VF              0x01
#define ST7567_POWER_CONTROL_VR              0x02
#define ST7567_POWER_CONTROL_VB              0x04
 
#define ST7567_REGULATION_RATIO              0x20
#define ST7567_REGULATION_RATIO_3_0          0x00
#define ST7567_REGULATION_RATIO_3_5          0x01
#define ST7567_REGULATION_RATIO_4_0          0x02
#define ST7567_REGULATION_RATIO_4_5          0x03
#define ST7567_REGULATION_RATIO_5_0          0x04 /* Default */
#define ST7567_REGULATION_RATIO_5_5          0x05
#define ST7567_REGULATION_RATIO_6_0          0x06
#define ST7567_REGULATION_RATIO_6_5          0x07
 
#define ST7567_SET_EV                        0x81
#define ST7567_SET_EV_MASK                   0x3F
 
#if (ST7567_MODEL == ST7567_MODEL_ST7565)
    #define ST7567_MODE_SLEEP                0xAC
    #define ST7567_MODE_NORMAL               0xAD
#endif
 
#define ST7567_SET_BOOSTER                   0xF8 /* Set booster level */
#define ST7567_SET_BOOSTER_4X                0x00
#define ST7567_SET_BOOSTER_5X                0x01
#define ST7567_SET_BOOSTER_6X                0x11
 
#define ST7567_NOP                           0xE3
#define ST7567_TEST                          0xFE
 
 
#ifndef ST7567_TIMEOUT
#define ST7567_TIMEOUT                  20000
#endif
 
#define ST7567_COLOR_FRONT 1U
#define ST7567_COLOR_BACK  0U
 
 
typedef struct {
    uint8_t width;
    uint8_t height;
    uint8_t order;
    uint8_t bytes;
    const uint8_t *dat;
} FontDef_t;
 
extern __CODE FontDef_t Font_3x5;
extern __CODE FontDef_t Font_5x7;
 
void ST7567_WriteData(uint8_t dat);
void ST7567_WriteSameData(uint8_t dat, uint32_t size);
 
void ST7567_WriteCommand(uint8_t command);
 
void ST7567_Reset(void);
 
void ST7567_Init(void);
 
void ST7567_SetPowerSaveMode(HAL_State_t state);
 
 
void ST7567_SetBackLightState(HAL_State_t state);
 
void ST7567_SetContrast(uint8_t val);
 
void ST7567_UpdateScreen(void);
 
void ST7567_ToggleInvert(void);
 
void ST7567_Fill(uint8_t Color);
 
void ST7567_DrawPixel(uint8_t x, uint8_t y, uint8_t color);
 
void ST7567_GotoXY(uint16_t x, uint16_t y);
 
char ST7567_Putc(char ch, FontDef_t* Font, uint8_t color);
 
char ST7567_Puts(char* str, FontDef_t* Font, uint8_t color);
 
void ST7567_DrawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint8_t c);
 
#endif // __ST7567_H_