osd  2.0.0.0
osd.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef OSD_H
36 #define OSD_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
55 
56 
57 
58 // -------------------------------------------------------------- PUBLIC MACROS
69 #define OSD_MAP_MIKROBUS( cfg, mikrobus ) \
70  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
71  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
72  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
73  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
74  cfg.los = MIKROBUS( mikrobus, MIKROBUS_AN ); \
75  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
76  cfg.hsy = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
77  cfg.vsy = MIKROBUS( mikrobus, MIKROBUS_INT )
78 
84 #define OSD_OK 0x00
85 #define OSD_ERROR -1
86 
92 #define OSD_VM0_REG 0x00
93 #define OSD_VM1_REG 0x01
94 #define OSD_HOS_REG 0x02
95 #define OSD_VOS_REG 0x03
96 #define OSD_DMM_REG 0x04
97 #define OSD_DMAH_REG 0x05
98 #define OSD_DMAL_REG 0x06
99 #define OSD_DMDI_REG 0x07
100 #define OSD_CMM_REG 0x08
101 #define OSD_CMAH_REG 0x09
102 #define OSD_RB0_REG 0x10
103 #define OSD_CMAL_REG 0x0A
104 #define OSD_CMDI_REG 0x0B
105 #define OSD_OSDM_REG 0x0C
106 #define OSD_OSDBL_REG 0x6C
107 #define OSD_STAT_REG 0xA0
108 #define OSD_DMDO_REG 0xB0
109 #define OSD_CMDO_REG 0xC0
110 
116 #define OSD_WRITE_CMD 0x7F
117 #define OSD_READ_CMD 0x80
118 
119 #define OSD_CLEAR_DISPLAY 0x04
120 #define OSD_CLEAR_DISPLAY_VERT 0x06
121 #define OSD_END_STRING 0xFF
122 #define OSD_WRITE_NVR 0xA0
123 
124 #define OSD_WHITE_LEVEL_80 0x03
125 #define OSD_WHITE_LEVEL_90 0x02
126 #define OSD_WHITE_LEVEL_100 0x01
127 #define OSD_WHITE_LEVEL_120 0x00
128 
129 #define OSD_MAX_FONT_ROM 0xFF
130 #define OSD_STATUS_REG_NVR_BUSY 0x20
131 #define OSD_NVM_RAM_SIZE 0x36
132  // End group macro
136 // --------------------------------------------------------------- PUBLIC TYPES
145 typedef struct
146 {
147  // Output pins
148  digital_out_t rst;
149 
150  // Input pins
151  digital_in_t los;
152  digital_in_t hsy;
153  digital_in_t vsy;
154 
155  // Modules
156  spi_master_t spi;
157  pin_name_t chip_select;
158 
159 } osd_t;
160 
164 typedef struct
165 {
166  // Communication gpio pins
167  pin_name_t miso;
168  pin_name_t mosi;
169  pin_name_t sck;
170  pin_name_t cs;
171 
172  // Additional gpio pins
173  pin_name_t los;
174  pin_name_t rst;
175  pin_name_t hsy;
176  pin_name_t vsy;
177 
178  // static variable
179  uint32_t spi_speed;
180  spi_master_mode_t spi_mode;
181  spi_master_chip_select_polarity_t cs_polarity;
182 
183 } osd_cfg_t;
184 
188 typedef struct
189 {
190  uint8_t n_byte; // number of bytes
191  uint8_t flags; // flags: 1 <==> blink; 2 <==> invert
192  uint8_t line_pos; // line position value
193  uint8_t row_pos; // row position value
194 
196  // End types group
198 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
199 
204 #ifdef __cplusplus
205 extern "C"{
206 #endif
207 
216 void osd_cfg_setup ( osd_cfg_t *cfg );
217 
225 err_t osd_init ( osd_t *ctx, osd_cfg_t *cfg );
226 
234 void osd_default_cfg ( osd_t *ctx );
235 
248 void osd_write_byte ( osd_t *ctx, uint8_t reg_address, uint8_t write_data );
249 
261 uint8_t osd_read_byte ( osd_t *ctx, uint8_t reg_address );
262 
277 void osd_hw_reset ( osd_t *ctx );
278 
289 void osd_enable ( osd_t *ctx );
290 
299 void osd_disable ( osd_t *ctx );
300 
313 void osd_write_character ( osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol );
314 
326 void osd_insert_custom_char ( osd_t *ctx, uint8_t chr_address, uint8_t custom_char );
327 
341 void osd_clears_char_places ( osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x,
342  uint8_t end_y );
343 
354 void osd_set_ntsc ( osd_t *ctx );
355 
366 void osd_set_pal ( osd_t *ctx );
367 
368 
387 void osd_set_video_sync_mode ( osd_t *ctx, uint8_t sync_mode );
388 
400 
412 
431 void osd_vertical_sync_screen ( osd_t *ctx, uint8_t vsync );
432 
449 void osd_soft_reset ( osd_t *ctx );
450 
462 
474 
491 void osd_set_background_mode ( osd_t *ctx, uint8_t b_mode );
492 
513 void osd_set_background_brightness ( osd_t *ctx, uint8_t brightness );
514 
532 void osd_set_blinking_time ( osd_t *ctx, uint8_t blinking_time );
533 
553 void osd_set_blinking_duty_cycle ( osd_t *ctx, uint8_t blink_duty_cycle );
554 
577 void osd_set_horizontal_offset ( osd_t *ctx, uint8_t h_offset );
578 
601 void osd_set_vertical_offset ( osd_t *ctx, uint8_t v_offset );
602 
620 void osd_set_operation_mode ( osd_t *ctx, uint8_t op_mode );
621 
637 void osd_set_local_background_control ( osd_t *ctx, uint8_t lb_mode );
638 
648 void osd_blinking_on ( osd_t *ctx );
649 
660 void osd_blinking_off ( osd_t *ctx );
661 
670 
679 
698 
717 void osd_write_chars ( osd_t *ctx, uint8_t *symbol_buff, osd_write_chars_t *write_ctx );
718 
730 void osd_write_nvm_character ( osd_t *ctx, uint8_t v_chars, uint16_t v_index );
731 
740 
749 
761 
770 
779 
788 
811 void osd_set_sharpness ( osd_t *ctx, uint8_t s_data );
812 
821 
833 
871 uint8_t osd_get_status ( osd_t *ctx );
872 
901 
923 
941 uint8_t osd_get_los ( osd_t *ctx );
942 
960 uint8_t osd_get_vsync ( osd_t *ctx );
961 
979 uint8_t osd_get_hsync ( osd_t *ctx );
980 
981 #ifdef __cplusplus
982 }
983 #endif
984 #endif // _OSD_H_
985  // End public_function group
988 
989 // ------------------------------------------------------------------------- END
osd_disable_display_image
void osd_disable_display_image(osd_t *ctx)
Disable display of OSD image function.
osd_t::los
digital_in_t los
Definition: osd.h:151
osd_set_blinking_time
void osd_set_blinking_time(osd_t *ctx, uint8_t blinking_time)
Set blinking time.
osd_soft_reset
void osd_soft_reset(osd_t *ctx)
Software reset function.
osd_set_video_sync_mode
void osd_set_video_sync_mode(osd_t *ctx, uint8_t sync_mode)
Set video sync mode function.
osd_write_byte
void osd_write_byte(osd_t *ctx, uint8_t reg_address, uint8_t write_data)
Write the byte of data.
osd_character_blinking_off
void osd_character_blinking_off(osd_t *ctx)
Set blinking OFF function.
osd_cfg_t::miso
pin_name_t miso
Definition: osd.h:167
osd_cfg_t::hsy
pin_name_t hsy
Definition: osd.h:175
osd_get_vsync
uint8_t osd_get_vsync(osd_t *ctx)
Get vertical sync status function.
osd_write_chars_t::line_pos
uint8_t line_pos
Definition: osd.h:192
osd_cfg_setup
void osd_cfg_setup(osd_cfg_t *cfg)
Config Object Initialization function.
osd_hw_reset
void osd_hw_reset(osd_t *ctx)
Hardware reset function.
osd_blinking_off
void osd_blinking_off(osd_t *ctx)
Set blinking OFF function.
osd_write_chars_t::flags
uint8_t flags
Definition: osd.h:191
osd_set_pal
void osd_set_pal(osd_t *ctx)
Set PAL video standard function.
osd_cfg_t::sck
pin_name_t sck
Definition: osd.h:169
osd_set_horizontal_offset
void osd_set_horizontal_offset(osd_t *ctx, uint8_t h_offset)
Set horizontal offset function.
osd_t::chip_select
pin_name_t chip_select
Definition: osd.h:157
osd_t::vsy
digital_in_t vsy
Definition: osd.h:153
osd_get_hsync
uint8_t osd_get_hsync(osd_t *ctx)
Get horizontal sync status function.
osd_t::spi
spi_master_t spi
Definition: osd.h:156
osd_set_background_mode
void osd_set_background_mode(osd_t *ctx, uint8_t b_mode)
Set background mode.
osd_blinking_on
void osd_blinking_on(osd_t *ctx)
Set blinking ON function.
osd_clear_display_memory
void osd_clear_display_memory(osd_t *ctx)
Clear display memory.
osd_t::rst
digital_out_t rst
Definition: osd.h:148
osd_enable_video_buffer
void osd_enable_video_buffer(osd_t *ctx)
Enable video buffer.
osd_read_byte
uint8_t osd_read_byte(osd_t *ctx, uint8_t reg_address)
Read the byte of data function.
osd_clears_char_places
void osd_clears_char_places(osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x, uint8_t end_y)
Clears the character places function.
osd_cfg_t::mosi
pin_name_t mosi
Definition: osd.h:168
osd_get_character_data_out
uint8_t osd_get_character_data_out(osd_t *ctx)
Get character memory data out function.
osd_write_chars_t
Structure for osd_write_chars() call.
Definition: osd.h:189
osd_write_nvm_character
void osd_write_nvm_character(osd_t *ctx, uint8_t v_chars, uint16_t v_index)
Write NVM character function.
osd_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: osd.h:180
osd_insert_custom_char
void osd_insert_custom_char(osd_t *ctx, uint8_t chr_address, uint8_t custom_char)
Write custom character function.
osd_enable_display_image
void osd_enable_display_image(osd_t *ctx)
Enable display of OSD image function.
osd_cfg_t::rst
pin_name_t rst
Definition: osd.h:174
osd_disable_video_buffer
void osd_disable_video_buffer(osd_t *ctx)
Disable video buffer.
osd_write_chars_t::n_byte
uint8_t n_byte
Definition: osd.h:190
osd_normal_pixels_display
void osd_normal_pixels_display(osd_t *ctx)
Normal color of pixels on display function.
osd_cfg_t::los
pin_name_t los
Definition: osd.h:173
osd_invert_pixels_character
void osd_invert_pixels_character(osd_t *ctx)
Invert color of character pixels on display.
osd_t::hsy
digital_in_t hsy
Definition: osd.h:152
osd_write_character
void osd_write_character(osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol)
Write character by position function.
osd_set_character_color_black
void osd_set_character_color_black(osd_t *ctx)
Set the black background of the character function.
osd_character_blinking_on
void osd_character_blinking_on(osd_t *ctx)
Set blinking ON function.
osd_t
Click ctx object definition.
Definition: osd.h:146
osd_cfg_t
Click configuration structure definition.
Definition: osd.h:165
osd_get_display_data_out
uint8_t osd_get_display_data_out(osd_t *ctx)
Get display memory data out function.
osd_set_blinking_duty_cycle
void osd_set_blinking_duty_cycle(osd_t *ctx, uint8_t blink_duty_cycle)
Set blinking duty cycle function.
osd_write_chars_t::row_pos
uint8_t row_pos
Definition: osd.h:193
osd_set_background_brightness
void osd_set_background_brightness(osd_t *ctx, uint8_t brightness)
Set background brightness function.
osd_set_local_background_control
void osd_set_local_background_control(osd_t *ctx, uint8_t lb_mode)
Set local background control function.
osd_disable_auto_black
void osd_disable_auto_black(osd_t *ctx)
Disable automatic OSD black function.
osd_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: osd.h:181
osd_get_los
uint8_t osd_get_los(osd_t *ctx)
Get loss of sync status function.
osd_init
err_t osd_init(osd_t *ctx, osd_cfg_t *cfg)
Initialization function.
osd_get_status
uint8_t osd_get_status(osd_t *ctx)
Get status data function.
osd_cfg_t::spi_speed
uint32_t spi_speed
Definition: osd.h:179
osd_set_operation_mode
void osd_set_operation_mode(osd_t *ctx, uint8_t op_mode)
Set operation mode function.
osd_set_character_color_white
void osd_set_character_color_white(osd_t *ctx)
Set the white background of the character function.
osd_invert_pixels_display
void osd_invert_pixels_display(osd_t *ctx)
Invert color of pixels on display function.
osd_cfg_t::cs
pin_name_t cs
Definition: osd.h:170
osd_disable
void osd_disable(osd_t *ctx)
Disable OSD function.
osd_vertical_sync_screen
void osd_vertical_sync_screen(osd_t *ctx, uint8_t vsync)
Enable vertical synchronization of on-screen data function.
osd_default_cfg
void osd_default_cfg(osd_t *ctx)
Click Default Configuration function.
osd_enable
void osd_enable(osd_t *ctx)
Enable OSD function.
osd_write_chars
void osd_write_chars(osd_t *ctx, uint8_t *symbol_buff, osd_write_chars_t *write_ctx)
Write character function.
osd_cfg_t::vsy
pin_name_t vsy
Definition: osd.h:176
osd_set_ntsc
void osd_set_ntsc(osd_t *ctx)
Set NTSC video standard function.
osd_enable_auto_black
void osd_enable_auto_black(osd_t *ctx)
Enable automatic OSD black function.
osd_set_vertical_offset
void osd_set_vertical_offset(osd_t *ctx, uint8_t v_offset)
Set vertical offset function.
osd_set_sharpness
void osd_set_sharpness(osd_t *ctx, uint8_t s_data)
Set sharpness function.
osd_normal_pixels_character
void osd_normal_pixels_character(osd_t *ctx)
Normal color of character pixels on display.