iPXE
vram_settings.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <ipxe/uaccess.h>
27 #include <ipxe/settings.h>
28 
29 /** @file
30  *
31  * Video RAM dump
32  *
33  */
34 
35 /** Video RAM base address */
36 #define VRAM_BASE 0xb8000
37 
38 /** Video RAM length */
39 #define VRAM_LEN \
40  ( 80 /* columns */ * 25 /* rows */ * 2 /* bytes per character */ )
41 
42 /**
43  * Fetch video RAM setting
44  *
45  * @v data Buffer to fill with setting data
46  * @v len Length of buffer
47  * @ret len Length of setting data, or negative error
48  */
49 static int vram_fetch ( void *data, size_t len ) {
50  userptr_t vram = phys_to_user ( VRAM_BASE );
51 
52  /* Copy video RAM */
53  if ( len > VRAM_LEN )
54  len = VRAM_LEN;
55  copy_from_user ( data, vram, 0, len );
56 
57  return VRAM_LEN;
58 }
59 
60 /** Video RAM setting */
61 const struct setting vram_setting __setting ( SETTING_MISC, vram ) = {
62  .name = "vram",
63  .description = "Video RAM",
64  .type = &setting_type_base64,
65  .scope = &builtin_scope,
66 };
67 
68 /** Video RAM built-in setting */
69 struct builtin_setting vram_builtin_setting __builtin_setting = {
70  .setting = &vram_setting,
71  .fetch = vram_fetch,
72 };
static int vram_fetch(void *data, size_t len)
Fetch video RAM setting.
Definition: vram_settings.c:49
static __always_inline void copy_from_user(void *dest, userptr_t src, off_t src_off, size_t len)
Copy data from user buffer.
Definition: uaccess.h:337
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
userptr_t phys_to_user(unsigned long phys_addr)
Convert physical address to user pointer.
#define SETTING_MISC
Miscellaneous settings.
Definition: settings.h:80
Access to external ("user") memory.
const char * name
Name.
Definition: settings.h:28
const struct setting * setting
Setting.
Definition: settings.h:269
Configuration settings.
A built-in setting.
Definition: settings.h:267
struct builtin_setting vram_builtin_setting __builtin_setting
Video RAM built-in setting.
Definition: vram_settings.c:69
A setting.
Definition: settings.h:23
const struct settings_scope builtin_scope
Built-in setting scope.
Definition: settings.c:2505
uint32_t len
Length.
Definition: ena.h:14
#define VRAM_BASE
Video RAM base address.
Definition: vram_settings.c:36
uint8_t data[48]
Additional event data.
Definition: ena.h:22
#define VRAM_LEN
Video RAM length.
Definition: vram_settings.c:39
const struct setting vram_setting __setting(SETTING_MISC, vram)
Video RAM setting.
unsigned long userptr_t
A pointer to a user buffer.
Definition: uaccess.h:33