2 * Copyright 2019 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
30 * DOC: DMUB interface and operation
32 * DMUB is the interface to the display DMCUB microcontroller on DCN hardware.
33 * It delegates hardware initialization and command submission to the
34 * microcontroller. DMUB is the shortname for DMCUB.
36 * This interface is not thread-safe. Ensure that all access to the interface
37 * is properly synchronized by the caller.
39 * Initialization and usage of the DMUB service should be done in the
42 * 1. dmub_srv_create()
43 * 2. dmub_srv_has_hw_support()
44 * 3. dmub_srv_calc_region_info()
45 * 4. dmub_srv_hw_init()
47 * The call to dmub_srv_create() is required to use the server.
49 * The calls to dmub_srv_has_hw_support() and dmub_srv_calc_region_info()
50 * are helpers to query cache window size and allocate framebuffer(s)
51 * for the cache windows.
53 * The call to dmub_srv_hw_init() programs the DMCUB registers to prepare
54 * for command submission. Commands can be queued via dmub_srv_cmd_queue()
55 * and executed via dmub_srv_cmd_execute().
57 * If the queue is full the dmub_srv_wait_for_idle() call can be used to
58 * wait until the queue has been cleared.
60 * Destroying the DMUB service can be done by calling dmub_srv_destroy().
61 * This does not clear DMUB hardware state, only software state.
63 * The interface is intended to be standalone and should not depend on any
64 * other component within DAL.
67 #include "inc/dmub_cmd.h"
69 #if defined(__cplusplus)
73 /* Forward declarations */
75 struct dmub_srv_common_regs;
77 /* enum dmub_status - return code for dmcub functions */
81 DMUB_STATUS_QUEUE_FULL,
86 /* enum dmub_asic - dmub asic identifier */
97 /* enum dmub_window_id - dmub window identifier */
99 DMUB_WINDOW_0_INST_CONST = 0,
101 DMUB_WINDOW_2_BSS_DATA,
103 DMUB_WINDOW_4_MAILBOX,
104 DMUB_WINDOW_5_TRACEBUFF,
105 DMUB_WINDOW_6_FW_STATE,
106 DMUB_WINDOW_7_SCRATCH_MEM,
111 * struct dmub_region - dmub hw memory region
112 * @base: base address for region, must be 256 byte aligned
113 * @top: top address for region
121 * struct dmub_window - dmub hw cache window
122 * @off: offset to the fb memory in gpu address space
123 * @r: region in uc address space for cache window
126 union dmub_addr offset;
127 struct dmub_region region;
131 * struct dmub_fb - defines a dmub framebuffer memory region
132 * @cpu_addr: cpu virtual address for the region, NULL if invalid
133 * @gpu_addr: gpu virtual address for the region, NULL if invalid
134 * @size: size of the region in bytes, zero if invalid
143 * struct dmub_srv_region_params - params used for calculating dmub regions
144 * @inst_const_size: size of the fw inst const section
145 * @bss_data_size: size of the fw bss data section
146 * @vbios_size: size of the vbios data
147 * @fw_bss_data: raw firmware bss data section
149 struct dmub_srv_region_params {
150 uint32_t inst_const_size;
151 uint32_t bss_data_size;
153 const uint8_t *fw_inst_const;
154 const uint8_t *fw_bss_data;
158 * struct dmub_srv_region_info - output region info from the dmub service
159 * @fb_size: required minimum fb size for all regions, aligned to 4096 bytes
160 * @num_regions: number of regions used by the dmub service
161 * @regions: region info
163 * The regions are aligned such that they can be all placed within the
164 * same framebuffer but they can also be placed into different framebuffers.
166 * The size of each region can be calculated by the caller:
167 * size = reg.top - reg.base
169 * Care must be taken when performing custom allocations to ensure that each
170 * region base address is 256 byte aligned.
172 struct dmub_srv_region_info {
175 struct dmub_region regions[DMUB_WINDOW_TOTAL];
179 * struct dmub_srv_fb_params - parameters used for driver fb setup
180 * @region_info: region info calculated by dmub service
181 * @cpu_addr: base cpu address for the framebuffer
182 * @gpu_addr: base gpu virtual address for the framebuffer
184 struct dmub_srv_fb_params {
185 const struct dmub_srv_region_info *region_info;
191 * struct dmub_srv_fb_info - output fb info from the dmub service
192 * @num_fbs: number of required dmub framebuffers
193 * @fbs: fb data for each region
195 * Output from the dmub service helper that can be used by the
196 * driver to prepare dmub_fb that can be passed into the dmub
199 * Assumes that all regions are within the same framebuffer
200 * and have been setup according to the region_info generated
201 * by the dmub service.
203 struct dmub_srv_fb_info {
205 struct dmub_fb fb[DMUB_WINDOW_TOTAL];
209 * struct dmub_srv_base_funcs - Driver specific base callbacks
211 struct dmub_srv_base_funcs {
215 * Hook for reading a register.
217 * Return: The 32-bit register value from the given address.
219 uint32_t (*reg_read)(void *ctx, uint32_t address);
224 * Hook for writing a value to the register specified by address.
226 void (*reg_write)(void *ctx, uint32_t address, uint32_t value);
230 * struct dmub_srv_hw_funcs - hardware sequencer funcs for dmub
232 struct dmub_srv_hw_funcs {
233 /* private: internal use only */
235 void (*init)(struct dmub_srv *dmub);
237 void (*reset)(struct dmub_srv *dmub);
239 void (*reset_release)(struct dmub_srv *dmub);
241 void (*backdoor_load)(struct dmub_srv *dmub,
242 const struct dmub_window *cw0,
243 const struct dmub_window *cw1);
245 void (*setup_windows)(struct dmub_srv *dmub,
246 const struct dmub_window *cw2,
247 const struct dmub_window *cw3,
248 const struct dmub_window *cw4,
249 const struct dmub_window *cw5,
250 const struct dmub_window *cw6);
252 void (*setup_mailbox)(struct dmub_srv *dmub,
253 const struct dmub_region *inbox1);
255 uint32_t (*get_inbox1_rptr)(struct dmub_srv *dmub);
257 void (*set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
259 uint32_t (*emul_get_inbox1_rptr)(struct dmub_srv *dmub);
261 void (*emul_set_inbox1_wptr)(struct dmub_srv *dmub, uint32_t wptr_offset);
263 bool (*is_supported)(struct dmub_srv *dmub);
265 bool (*is_hw_init)(struct dmub_srv *dmub);
267 bool (*is_phy_init)(struct dmub_srv *dmub);
268 void (*enable_dmub_boot_options)(struct dmub_srv *dmub);
270 void (*skip_dmub_panel_power_sequence)(struct dmub_srv *dmub, bool skip);
272 union dmub_fw_boot_status (*get_fw_status)(struct dmub_srv *dmub);
275 void (*set_gpint)(struct dmub_srv *dmub,
276 union dmub_gpint_data_register reg);
278 bool (*is_gpint_acked)(struct dmub_srv *dmub,
279 union dmub_gpint_data_register reg);
281 uint32_t (*get_gpint_response)(struct dmub_srv *dmub);
285 * struct dmub_srv_create_params - params for dmub service creation
286 * @base_funcs: driver supplied base routines
287 * @hw_funcs: optional overrides for hw funcs
288 * @user_ctx: context data for callback funcs
289 * @asic: driver supplied asic
290 * @fw_version: the current firmware version, if any
291 * @is_virtual: false for hw support only
293 struct dmub_srv_create_params {
294 struct dmub_srv_base_funcs funcs;
295 struct dmub_srv_hw_funcs *hw_funcs;
303 * struct dmub_srv_hw_params - params for dmub hardware initialization
304 * @fb: framebuffer info for each region
305 * @fb_base: base of the framebuffer aperture
306 * @fb_offset: offset of the framebuffer aperture
307 * @psp_version: psp version to pass for DMCU init
308 * @load_inst_const: true if DMUB should load inst const fw
310 struct dmub_srv_hw_params {
311 struct dmub_fb *fb[DMUB_WINDOW_TOTAL];
314 uint32_t psp_version;
315 bool load_inst_const;
316 bool skip_panel_power_sequence;
320 * struct dmub_srv - software state for dmcub
321 * @asic: dmub asic identifier
322 * @user_ctx: user provided context for the dmub_srv
323 * @fw_version: the current firmware version, if any
324 * @is_virtual: false if hardware support only
325 * @fw_state: dmub firmware state pointer
332 struct dmub_fb scratch_mem_fb;
333 volatile const struct dmub_fw_state *fw_state;
335 /* private: internal use only */
336 const struct dmub_srv_common_regs *regs;
338 struct dmub_srv_base_funcs funcs;
339 struct dmub_srv_hw_funcs hw_funcs;
340 struct dmub_rb inbox1_rb;
347 uint32_t psp_version;
349 /* Feature capabilities reported by fw */
350 struct dmub_feature_caps feature_caps;
354 * DMUB firmware version helper macro - useful for checking if the version
355 * of a firmware to know if feature or functionality is supported or present.
357 #define DMUB_FW_VERSION(major, minor, revision) \
358 ((((major) & 0xFF) << 24) | (((minor) & 0xFF) << 16) | ((revision) & 0xFFFF))
361 * dmub_srv_create() - creates the DMUB service.
362 * @dmub: the dmub service
363 * @params: creation parameters for the service
366 * DMUB_STATUS_OK - success
367 * DMUB_STATUS_INVALID - unspecified error
369 enum dmub_status dmub_srv_create(struct dmub_srv *dmub,
370 const struct dmub_srv_create_params *params);
373 * dmub_srv_destroy() - destroys the DMUB service.
374 * @dmub: the dmub service
376 void dmub_srv_destroy(struct dmub_srv *dmub);
379 * dmub_srv_calc_region_info() - retreives region info from the dmub service
380 * @dmub: the dmub service
381 * @params: parameters used to calculate region locations
382 * @info_out: the output region info from dmub
384 * Calculates the base and top address for all relevant dmub regions
385 * using the parameters given (if any).
388 * DMUB_STATUS_OK - success
389 * DMUB_STATUS_INVALID - unspecified error
392 dmub_srv_calc_region_info(struct dmub_srv *dmub,
393 const struct dmub_srv_region_params *params,
394 struct dmub_srv_region_info *out);
397 * dmub_srv_calc_region_info() - retreives fb info from the dmub service
398 * @dmub: the dmub service
399 * @params: parameters used to calculate fb locations
400 * @info_out: the output fb info from dmub
402 * Calculates the base and top address for all relevant dmub regions
403 * using the parameters given (if any).
406 * DMUB_STATUS_OK - success
407 * DMUB_STATUS_INVALID - unspecified error
409 enum dmub_status dmub_srv_calc_fb_info(struct dmub_srv *dmub,
410 const struct dmub_srv_fb_params *params,
411 struct dmub_srv_fb_info *out);
414 * dmub_srv_has_hw_support() - returns hw support state for dmcub
415 * @dmub: the dmub service
416 * @is_supported: hw support state
418 * Queries the hardware for DMCUB support and returns the result.
420 * Can be called before dmub_srv_hw_init().
423 * DMUB_STATUS_OK - success
424 * DMUB_STATUS_INVALID - unspecified error
426 enum dmub_status dmub_srv_has_hw_support(struct dmub_srv *dmub,
430 * dmub_srv_is_hw_init() - returns hardware init state
433 * DMUB_STATUS_OK - success
434 * DMUB_STATUS_INVALID - unspecified error
436 enum dmub_status dmub_srv_is_hw_init(struct dmub_srv *dmub, bool *is_hw_init);
439 * dmub_srv_hw_init() - initializes the underlying DMUB hardware
440 * @dmub: the dmub service
441 * @params: params for hardware initialization
443 * Resets the DMUB hardware and performs backdoor loading of the
444 * required cache regions based on the input framebuffer regions.
447 * DMUB_STATUS_OK - success
448 * DMUB_STATUS_NO_CTX - dmcub context not initialized
449 * DMUB_STATUS_INVALID - unspecified error
451 enum dmub_status dmub_srv_hw_init(struct dmub_srv *dmub,
452 const struct dmub_srv_hw_params *params);
455 * dmub_srv_hw_reset() - puts the DMUB hardware in reset state if initialized
456 * @dmub: the dmub service
458 * Before destroying the DMUB service or releasing the backing framebuffer
459 * memory we'll need to put the DMCUB into reset first.
461 * A subsequent call to dmub_srv_hw_init() will re-enable the DMCUB.
464 * DMUB_STATUS_OK - success
465 * DMUB_STATUS_INVALID - unspecified error
467 enum dmub_status dmub_srv_hw_reset(struct dmub_srv *dmub);
470 * dmub_srv_cmd_queue() - queues a command to the DMUB
471 * @dmub: the dmub service
472 * @cmd: the command to queue
474 * Queues a command to the DMUB service but does not begin execution
478 * DMUB_STATUS_OK - success
479 * DMUB_STATUS_QUEUE_FULL - no remaining room in queue
480 * DMUB_STATUS_INVALID - unspecified error
482 enum dmub_status dmub_srv_cmd_queue(struct dmub_srv *dmub,
483 const union dmub_rb_cmd *cmd);
486 * dmub_srv_cmd_execute() - Executes a queued sequence to the dmub
487 * @dmub: the dmub service
489 * Begins execution of queued commands on the dmub.
492 * DMUB_STATUS_OK - success
493 * DMUB_STATUS_INVALID - unspecified error
495 enum dmub_status dmub_srv_cmd_execute(struct dmub_srv *dmub);
498 * dmub_srv_wait_for_auto_load() - Waits for firmware auto load to complete
499 * @dmub: the dmub service
500 * @timeout_us: the maximum number of microseconds to wait
502 * Waits until firmware has been autoloaded by the DMCUB. The maximum
503 * wait time is given in microseconds to prevent spinning forever.
505 * On ASICs without firmware autoload support this function will return
509 * DMUB_STATUS_OK - success
510 * DMUB_STATUS_TIMEOUT - wait for phy init timed out
511 * DMUB_STATUS_INVALID - unspecified error
513 enum dmub_status dmub_srv_wait_for_auto_load(struct dmub_srv *dmub,
514 uint32_t timeout_us);
517 * dmub_srv_wait_for_phy_init() - Waits for DMUB PHY init to complete
518 * @dmub: the dmub service
519 * @timeout_us: the maximum number of microseconds to wait
521 * Waits until the PHY has been initialized by the DMUB. The maximum
522 * wait time is given in microseconds to prevent spinning forever.
524 * On ASICs without PHY init support this function will return
528 * DMUB_STATUS_OK - success
529 * DMUB_STATUS_TIMEOUT - wait for phy init timed out
530 * DMUB_STATUS_INVALID - unspecified error
532 enum dmub_status dmub_srv_wait_for_phy_init(struct dmub_srv *dmub,
533 uint32_t timeout_us);
536 * dmub_srv_wait_for_idle() - Waits for the DMUB to be idle
537 * @dmub: the dmub service
538 * @timeout_us: the maximum number of microseconds to wait
540 * Waits until the DMUB buffer is empty and all commands have
541 * finished processing. The maximum wait time is given in
542 * microseconds to prevent spinning forever.
545 * DMUB_STATUS_OK - success
546 * DMUB_STATUS_TIMEOUT - wait for buffer to flush timed out
547 * DMUB_STATUS_INVALID - unspecified error
549 enum dmub_status dmub_srv_wait_for_idle(struct dmub_srv *dmub,
550 uint32_t timeout_us);
553 * dmub_srv_send_gpint_command() - Sends a GPINT based command.
554 * @dmub: the dmub service
555 * @command_code: the command code to send
556 * @param: the command parameter to send
557 * @timeout_us: the maximum number of microseconds to wait
559 * Sends a command via the general purpose interrupt (GPINT).
560 * Waits for the number of microseconds specified by timeout_us
561 * for the command ACK before returning.
563 * Can be called after software initialization.
566 * DMUB_STATUS_OK - success
567 * DMUB_STATUS_TIMEOUT - wait for ACK timed out
568 * DMUB_STATUS_INVALID - unspecified error
571 dmub_srv_send_gpint_command(struct dmub_srv *dmub,
572 enum dmub_gpint_command command_code,
573 uint16_t param, uint32_t timeout_us);
576 * dmub_srv_get_gpint_response() - Queries the GPINT response.
577 * @dmub: the dmub service
578 * @response: the response for the last GPINT
580 * Returns the response code for the last GPINT interrupt.
582 * Can be called after software initialization.
585 * DMUB_STATUS_OK - success
586 * DMUB_STATUS_INVALID - unspecified error
588 enum dmub_status dmub_srv_get_gpint_response(struct dmub_srv *dmub,
592 * dmub_flush_buffer_mem() - Read back entire frame buffer region.
593 * This ensures that the write from x86 has been flushed and will not
595 * @fb: frame buffer to flush
597 * Can be called after software initialization.
599 void dmub_flush_buffer_mem(const struct dmub_fb *fb);
602 * dmub_srv_get_fw_boot_status() - Returns the DMUB boot status bits.
604 * @dmub: the dmub service
605 * @status: out pointer for firmware status
608 * DMUB_STATUS_OK - success
609 * DMUB_STATUS_INVALID - unspecified error, unsupported
611 enum dmub_status dmub_srv_get_fw_boot_status(struct dmub_srv *dmub,
612 union dmub_fw_boot_status *status);
614 enum dmub_status dmub_srv_cmd_with_reply_data(struct dmub_srv *dmub,
615 union dmub_rb_cmd *cmd);
617 #if defined(__cplusplus)
621 #endif /* _DMUB_SRV_H_ */