osd.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE 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. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef OSD_H
#define OSD_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define OSD_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.los = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.hsy = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.vsy = MIKROBUS( mikrobus, MIKROBUS_INT )
#define OSD_OK                      0x00
#define OSD_ERROR                  -1
#define OSD_VM0_REG                 0x00
#define OSD_VM1_REG                 0x01
#define OSD_HOS_REG                 0x02
#define OSD_VOS_REG                 0x03
#define OSD_DMM_REG                 0x04
#define OSD_DMAH_REG                0x05
#define OSD_DMAL_REG                0x06
#define OSD_DMDI_REG                0x07
#define OSD_CMM_REG                 0x08
#define OSD_CMAH_REG                0x09
#define OSD_RB0_REG                 0x10
#define OSD_CMAL_REG                0x0A
#define OSD_CMDI_REG                0x0B
#define OSD_OSDM_REG                0x0C
#define OSD_OSDBL_REG               0x6C
#define OSD_STAT_REG                0xA0
#define OSD_DMDO_REG                0xB0
#define OSD_CMDO_REG                0xC0
#define OSD_WRITE_CMD               0x7F
#define OSD_READ_CMD                0x80
 
#define OSD_CLEAR_DISPLAY           0x04
#define OSD_CLEAR_DISPLAY_VERT      0x06
#define OSD_END_STRING              0xFF
#define OSD_WRITE_NVR               0xA0
 
#define OSD_WHITE_LEVEL_80          0x03
#define OSD_WHITE_LEVEL_90          0x02
#define OSD_WHITE_LEVEL_100         0x01
#define OSD_WHITE_LEVEL_120         0x00
 
#define OSD_MAX_FONT_ROM            0xFF
#define OSD_STATUS_REG_NVR_BUSY     0x20
#define OSD_NVM_RAM_SIZE            0x36
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t rst;
 
    // Input pins 
    digital_in_t los;
    digital_in_t hsy;
    digital_in_t vsy;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
 
} osd_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
    pin_name_t los;
    pin_name_t rst;
    pin_name_t hsy;
    pin_name_t vsy;
 
    // static variable 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} osd_cfg_t;
 
typedef struct 
{
    uint8_t n_byte;    // number of bytes
    uint8_t flags;     // flags: 1 <==> blink; 2 <==> invert 
    uint8_t line_pos;  // line position value
    uint8_t row_pos;   // row position value
 
} osd_write_chars_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void osd_cfg_setup ( osd_cfg_t *cfg );
 
err_t osd_init ( osd_t *ctx, osd_cfg_t *cfg );
 
void osd_default_cfg  ( osd_t *ctx );
 
void osd_write_byte  ( osd_t *ctx, uint8_t reg_address, uint8_t write_data );
 
uint8_t osd_read_byte ( osd_t *ctx, uint8_t reg_address );
 
void osd_hw_reset ( osd_t *ctx );
 
void osd_enable ( osd_t *ctx );
 
void osd_disable ( osd_t *ctx );
 
void osd_write_character ( osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol );
 
void osd_insert_custom_char ( osd_t *ctx, uint8_t chr_address, uint8_t custom_char );
 
void osd_clears_char_places ( osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x,
                             uint8_t end_y );
 
void osd_set_ntsc ( osd_t *ctx );
 
void osd_set_pal ( osd_t *ctx );
 
 
void osd_set_video_sync_mode ( osd_t *ctx, uint8_t sync_mode );
 
void osd_enable_display_image ( osd_t *ctx );
 
void osd_disable_display_image ( osd_t *ctx );
 
void osd_vertical_sync_screen ( osd_t *ctx, uint8_t vsync );
 
void osd_soft_reset ( osd_t *ctx );
 
void osd_enable_video_buffer ( osd_t *ctx );
 
void osd_disable_video_buffer ( osd_t *ctx );
 
void osd_set_background_mode ( osd_t *ctx, uint8_t b_mode );
 
void osd_set_background_brightness ( osd_t *ctx, uint8_t brightness );
 
void osd_set_blinking_time ( osd_t *ctx, uint8_t blinking_time );
 
void osd_set_blinking_duty_cycle ( osd_t *ctx, uint8_t blink_duty_cycle );
 
void osd_set_horizontal_offset ( osd_t *ctx, uint8_t h_offset );
 
void osd_set_vertical_offset ( osd_t *ctx, uint8_t v_offset );
 
void osd_set_operation_mode ( osd_t *ctx, uint8_t op_mode );
 
void osd_set_local_background_control ( osd_t *ctx, uint8_t lb_mode );
 
void osd_blinking_on ( osd_t *ctx );
 
void osd_blinking_off ( osd_t *ctx );
 
void osd_invert_pixels_display ( osd_t *ctx );
 
void osd_normal_pixels_display ( osd_t *ctx );
 
void osd_clear_display_memory ( osd_t *ctx );
 
void osd_write_chars ( osd_t *ctx, uint8_t *symbol_buff, osd_write_chars_t *write_ctx );
 
void osd_write_nvm_character ( osd_t *ctx, uint8_t v_chars, uint16_t v_index );
 
void osd_set_character_color_white ( osd_t *ctx );
 
void osd_set_character_color_black ( osd_t *ctx );
 
void osd_character_blinking_on ( osd_t *ctx );
 
void osd_character_blinking_off ( osd_t *ctx );
 
void osd_invert_pixels_character ( osd_t *ctx );
 
void osd_normal_pixels_character ( osd_t *ctx );
 
void osd_set_sharpness ( osd_t *ctx, uint8_t s_data );
 
void osd_enable_auto_black ( osd_t *ctx );
 
void osd_disable_auto_black ( osd_t *ctx );
 
uint8_t osd_get_status ( osd_t *ctx );
 
uint8_t osd_get_display_data_out ( osd_t *ctx );
 
uint8_t osd_get_character_data_out ( osd_t *ctx );
 
uint8_t osd_get_los ( osd_t *ctx );
 
uint8_t osd_get_vsync ( osd_t *ctx );
 
uint8_t osd_get_hsync ( osd_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _OSD_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END