luv090909/py32f0-template
1
0
Fork 0
mirror of https://github.com/IcedRooibos/py32f0-template.git synced 2025-10-29 08:52:04 -07:00
Code Issues Packages Projects Releases Wiki Activity
py32f0-template/Examples/LL/SPI/ST7567_128x64LCD/st7567.h
IOsetting 4aefda2594 fix: ll st7567, reverse display
2023-01-23 23:28:56 +08:00

348 lines
13 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/******************************************************************************
**
* \file st7567.h
* \author IOsetting | iosetting@outlook.com
* \date
* \brief Library of ST7567 LCD
* \note
* \version v0.1
* \ingroup demo
*
******************************************************************************/
#ifndef __ST7567_H_
#define __ST7567_H_
#include "main.h"
#include "ascii_fonts.h"
#define ST7567_BUF_SIZE 1024
#define ST7567_HARDWARE_SPI 1
// CS: PB2
#define ST7567_CS_LOW LL_GPIO_ResetOutputPin(GPIOB, LL_GPIO_PIN_2)
#define ST7567_CS_HIGH LL_GPIO_SetOutputPin(GPIOB, LL_GPIO_PIN_2)
// SCK: PB3
#define ST7567_SCK_PORT GPIOB
#define ST7567_SCK_PIN LL_GPIO_PIN_3
// MOSI: PB5
#define ST7567_MOSI_PORT GPIOB
#define ST7567_MOSI_PIN LL_GPIO_PIN_5
// Reset: PA8
#define ST7567_RESET_LOW LL_GPIO_ResetOutputPin(GPIOA, LL_GPIO_PIN_8)
#define ST7567_RESET_HIGH LL_GPIO_SetOutputPin(GPIOA, LL_GPIO_PIN_8)
// DC: PA9
#define ST7567_DC_LOW LL_GPIO_ResetOutputPin(GPIOA, LL_GPIO_PIN_9)
#define ST7567_DC_HIGH LL_GPIO_SetOutputPin(GPIOA, LL_GPIO_PIN_9)
// Black Light: PA10
#define ST7567_BL_LOW LL_GPIO_ResetOutputPin(GPIOA, LL_GPIO_PIN_10)
#define ST7567_BL_HIGH LL_GPIO_SetOutputPin(GPIOA, LL_GPIO_PIN_10)
// X width
#define ST7567_WIDTH 128
// Y height
#define ST7567_HEIGHT 64
// Additional bytes in each row
#define ST7567_SEG_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_REVERSE
/* ST7567 commands definitions */
#define ST7567_DISPLAY_OFF 0xAE /* 0xae: Display OFF (sleep mode) */
#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 */
#define ST7567_SET_PAGE_ADDRESS_MASK 0x07
#define ST7567_SET_COLUMN_ADDRESS_MSB 0x10 /* 0x10-0x1f: Set higher column address */
#define ST7567_SET_COLUMN_ADDRESS_MSB_MASK 0x0f
#define ST7567_SET_COLUMN_ADDRESS_LSB 0x00 /* 0x00-0x0f: Set lower column address */
#define ST7567_SET_COLUMN_ADDRESS_LSB_MASK 0x0F
/**
* SEG: 0 - 131
*/
#define ST7567_SEG_DIRECTION_NORMAL 0xA0 /* 0xa0: Column address 0 is mapped to SEG0 */
#define ST7567_SEG_DIRECTION_REVERSE 0xA1 /* 0xa1: Column address 128 is mapped to SEG0 */
/**
* COM: 0 - 63
*/
#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 */
#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 */
/**
* This instruction controls the built-in power circuits.
* Typically, these 3 flags are turned ON at the same time.
*/
#define ST7567_POWER_CONTROL 0x28
#define ST7567_POWER_CONTROL_VF 0x01
#define ST7567_POWER_CONTROL_VR 0x02
#define ST7567_POWER_CONTROL_VB 0x04
/**
* The operation voltage (V0) calculation formula is shown below:
* (RR comes from Regulation Ratio, EV comes from EV[5:0])
* V0 = RR X [ 1 – (63 – EV) / 162 ] X 2.1, or
* V0 = RR X [ ( 99 + EV ) / 162 ] X 2.1
*/
#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
/**
* This is double byte instruction. The first byte set ST7567 into EV
* adjust mode and the following instruction will change the EV setting.
* That means these 2 bytes must be used together. They control the electronic
* volume to adjust a suitable V0 voltage for the LCD.
*/
#define ST7567_SET_EV 0x81
#define ST7567_SET_EV_MASK 0x3F
#define ST7567_SET_BOOSTER 0xF8 /* Set booster level */
#define ST7567_SET_BOOSTER_4X 0x00
#define ST7567_SET_BOOSTER_5X 0x01
#define ST7567_NOP 0xE3
#define ST7567_TEST 0xFE
#ifndef ST7567_TIMEOUT
#define ST7567_TIMEOUT 20000
#endif
/** Background color */
#define ST7567_COLOR_BACK 0x00
/** Front color */
#define ST7567_COLOR_FRONT 0x01
/**
* @brief Initializes ST7567 LCD
* @param None
* @retval None
*/
void ST7567_Init(void);
/**
* @brief Hardware reset ST7567 LCD
* @param None
* @retval None
*/
void ST7567_Reset(void);
/**
* @brief Turn ST7567 LCD backlight on
* @param None
* @retval None
*/
void ST7567_BackLight_On(void);
/**
* @brief Turn ST7567 LCD backlight off
* @param None
* @retval None
*/
void ST7567_BackLight_Off(void);
/**
* @brief Turn ST7567 LCD backlight off
* @param val: value between 0x00 ~ 0x3F
* @retval None
*/
void ST7567_SetContrast(uint8_t val);
/**
* @brief Updates buffer from internal RAM to LCD
* @note This function must be called each time you do some changes to LCD, to update buffer from RAM to LCD
* @param None
* @retval None
*/
void ST7567_UpdateScreen(void);
/**
* @brief Toggles pixels invertion inside internal RAM
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param None
* @retval None
*/
void ST7567_ToggleInvert(void);
/**
* @brief Fills entire LCD with desired color
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param Color: Color to be used for screen fill. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_Fill(uint8_t Color);
/**
* @brief Draws pixel at desired location
* @note @ref ST7567_UpdateScreen() must called after that in order to see updated LCD screen
* @param x: X location. This parameter can be a value between 0 and ST7567_WIDTH - 1
* @param y: Y location. This parameter can be a value between 0 and ST7567_HEIGHT - 1
* @param color: Color to be used for screen fill. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawPixel(uint16_t x, uint16_t y, uint8_t color);
/**
* @brief Sets cursor pointer to desired location for strings
* @param x: X location. This parameter can be a value between 0 and ST7567_WIDTH - 1
* @param y: Y location. This parameter can be a value between 0 and ST7567_HEIGHT - 1
* @retval None
*/
void ST7567_GotoXY(uint16_t x, uint16_t y);
/**
* @brief Puts character to internal RAM
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param ch: Character to be written
* @param *Font: Pointer to @ref FontDef_t structure with used font
* @param color: Color used for drawing. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval Character written
*/
char ST7567_Putc(char ch, FontDef_t* Font, uint8_t color);
/**
* @brief Puts string to internal RAM
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param *str: String to be written
* @param *Font: Pointer to @ref FontDef_t structure with used font
* @param color: Color used for drawing. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval Zero on success or character value when function failed
*/
char ST7567_Puts(char* str, FontDef_t* Font, uint8_t color);
/**
* @brief Draws line on LCD
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x0: Line X start point. Valid input is 0 to ST7567_WIDTH - 1
* @param y0: Line Y start point. Valid input is 0 to ST7567_HEIGHT - 1
* @param x1: Line X end point. Valid input is 0 to ST7567_WIDTH - 1
* @param y1: Line Y end point. Valid input is 0 to ST7567_HEIGHT - 1
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint8_t c);
/**
* @brief Draws rectangle on LCD
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x: Top left X start point. Valid input is 0 to ST7567_WIDTH - 1
* @param y: Top left Y start point. Valid input is 0 to ST7567_HEIGHT - 1
* @param w: Rectangle width in units of pixels
* @param h: Rectangle height in units of pixels
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawRectangle(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint8_t c);
/**
* @brief Draws filled rectangle on LCD
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x: Top left X start point. Valid input is 0 to ST7567_WIDTH - 1
* @param y: Top left Y start point. Valid input is 0 to ST7567_HEIGHT - 1
* @param w: Rectangle width in units of pixels
* @param h: Rectangle height in units of pixels
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawFilledRectangle(uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint8_t c);
/**
* @brief Draws triangle on LCD
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x1: First coordinate X location. Valid input is 0 to ST7567_WIDTH - 1
* @param y1: First coordinate Y location. Valid input is 0 to ST7567_HEIGHT - 1
* @param x2: Second coordinate X location. Valid input is 0 to ST7567_WIDTH - 1
* @param y2: Second coordinate Y location. Valid input is 0 to ST7567_HEIGHT - 1
* @param x3: Third coordinate X location. Valid input is 0 to ST7567_WIDTH - 1
* @param y3: Third coordinate Y location. Valid input is 0 to ST7567_HEIGHT - 1
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawTriangle(uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t x3, uint16_t y3, uint8_t color);
/**
* @brief Draws circle to STM buffer
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x: X location for center of circle. Valid input is 0 to ST7567_WIDTH - 1
* @param y: Y location for center of circle. Valid input is 0 to ST7567_HEIGHT - 1
* @param r: Circle radius in units of pixels
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawCircle(int16_t x0, int16_t y0, int16_t r, uint8_t c);
/**
* @brief Draws filled circle to STM buffer
* @note @ref ST7567_UpdateScreen() must be called after that in order to see updated LCD screen
* @param x: X location for center of circle. Valid input is 0 to ST7567_WIDTH - 1
* @param y: Y location for center of circle. Valid input is 0 to ST7567_HEIGHT - 1
* @param r: Circle radius in units of pixels
* @param c: Color to be used. This parameter can be a value of @ref ST7567_COLOR_t enumeration
* @retval None
*/
void ST7567_DrawFilledCircle(int16_t x0, int16_t y0, int16_t r, uint8_t c);
/**
* @brief Writes multi bytes to slave
* @param *I2Cx: I2C used
* @param address: 7 bit slave address, left aligned, bits 7:1 are used, LSB bit is not used
* @param reg: register to write to
* @param *data: pointer to data array to write it to slave
* @param count: how many bytes will be written
* @retval None
*/
void ST7567_Image(uint8_t *img, uint8_t frame, uint8_t x, uint8_t y);
/**
* @brief Writes single byte command to slave
* @param command: command to be written
* @retval None
*/
void ST7567_WriteCommand(uint8_t command);
/**
* @brief Writes single byte data to slave
* @param data: data to be written
* @retval None
*/
void ST7567_WriteData(uint8_t data);
/**
* @brief Test ST7567 LCD Display RAM
* @param None
* @retval None
*/
void ST7567_TestDisplayRAM(void);
#endif // __ST7567_H_
Reference in New Issue View Git Blame Copy Permalink