sif_ssd1608.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2023, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef SIF_SIF_SSD1608_H
#define SIF_SIF_SSD1608_H
 
#include <stdint.h>
#include "ca821x_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***********************************************************/
/********************* Pin connections *********************/
/***********************************************************/
/*
    Pin config for M2351:
    |---+- BUSY - Pin 31 (GPIO PB.5)
    |---+- RST  - Pin 15 (GPIO PA.15) on Chili2D, Pin 5 (GPIO PB.12) on Devboard
    |---+- DC   - Pin 34 (GPIO PB.2)
    |---+- CS   - GND
    |---+- CLK  - Pin 33 (GPIO PB.3)
    |---+- DIN  - Pin 32 (GPIO PB.4)
    |---+- GND  - (Pins 3/14/16/18-25/27/30)
    |---+- VCC  - Pin 13
 
*/
 
/* Pin configuration */
#define SIF_SSD1608_BUSY_PIN 31
 
#if (CASCODA_CHILI2_CONFIG == 2)
#define SIF_SSD1608_RST_PIN 5
#else
#define SIF_SSD1608_RST_PIN 15
#endif
 
#define SIF_SSD1608_DC_PIN 34
//#define SIF_SSD1608_CS_PIN 34
 
/* BUSY Timeout in [ms] */
#define SIF_SSD1608_BUSY_TIMEOUT 4000
 
/* Actual physical display resolution (in pixels) */
#define SIF_SSD1608_WIDTH_PHYSICAL 200
#define SIF_SSD1608_HEIGHT_PHYSICAL 200
 
#ifdef EPAPER_FULL_RESOLUTION
#define SIF_SSD1608_WIDTH_WINDOW SIF_SSD1608_WIDTH_PHYSICAL
#define SIF_SSD1608_HEIGHT_WINDOW SIF_SSD1608_HEIGHT_PHYSICAL
 
#define SIF_SSD1608_WIDTH SIF_SSD1608_WIDTH_PHYSICAL
#define SIF_SSD1608_HEIGHT SIF_SSD1608_HEIGHT_PHYSICAL
#else
// Display resolution that the window will be set to upon initialization
// Note: 192 was chosen because it is the closest number to 200, that is a
// multiple of 8 after having been divided by 2. (The problem with 200 is that
// 200/2 is 100, which is not divisible by 8).
#define SIF_SSD1608_WIDTH_WINDOW 192
#define SIF_SSD1608_HEIGHT_WINDOW 200
 
// Display resolution that the image buffer will be set to. This
// is the actual display resolution that ends up being used.
// This is done to save memory (200x200 resolution requires an image buffer
// of 5000 bytes, whereas 96*100 only requires 1200).
#define SIF_SSD1608_WIDTH (SIF_SSD1608_WIDTH_WINDOW / 2)
#define SIF_SSD1608_HEIGHT (SIF_SSD1608_WIDTH_WINDOW / 2)
#endif // EPAPER_FULL_RESOLUTION
 
/* QR code image array size */
#define ARRAY_SIZE (SIF_SSD1608_HEIGHT * SIF_SSD1608_WIDTH / 8)
 
/* Display update mode */
typedef enum
{
    FULL_UPDATE = 0,
    PARTIAL_UPDATE,
} SIF_SSD1608_Update_Mode;
 
/* Clear or no clear */
typedef enum
{
    WITH_CLEAR = 0,
    WITHOUT_CLEAR
} SIF_SSD1608_Clear_Mode;
 
/* update times in [ms] for scheduling when not waiting for busy signal */
#define SIF_SSD1608_TUPDATE_PARTIAL 350
 
/* CAUTION: Don't increase this number. We have observed that this results 
in the display often getting corrupted after a full update!! */
#define SIF_SSD1608_TUPDATE_FULL 1050
 
/* flag to avoid re-entry into display update functions when not waiting for busy */
extern bool sif_ssd1608_display_is_busy;
 
/* functions */
 
/******************************************************************************/
/***************************************************************************/ 
ca_error SIF_SSD1608_Initialise(SIF_SSD1608_Update_Mode mode);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_Deinitialise(void);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_ClearDisplay(void);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_StrongClearDisplay(void);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_DeepSleep(void);
 
/******************************************************************************/
/***************************************************************************/ 
ca_error SIF_SSD1608_overlay_qr_code(const char *text, uint8_t *image, uint8_t scale, uint8_t x, uint8_t y);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_DisplayImage(const uint8_t *image, SIF_SSD1608_Clear_Mode mode, bool full_resolution);
 
/******************************************************************************/
/***************************************************************************/ 
void SIF_SSD1608_DisplayImageNoWait(const uint8_t *image, SIF_SSD1608_Clear_Mode mode, bool full_resolution);
 
/******************************************************************************/
/***************************************************************************/ 
ca_error SIF_SSD1608_PowerDown(void *aContext);
 
#ifdef __cplusplus
}
#endif
 
#endif
// SIF_SIF_SSD1608_H