ГОСТ Р 71087-2023. Национальный стандарт Российской Федерации. Блоки сложно-функциональные. Руководство по программированию

Федеральное агентство по техническому регулированию и метрологии · № ГОСТ Р 71087-2023Действующий акт

(утв. и введен в действие Приказом Росстандарта от 09.11.2023 № 1370-ст)

Примечание

Документ введен в действие с 01.01.2024.

Утвержден и введен в действие
Приказом Федерального агентства
по техническому регулированию
и метрологии
от 9 ноября 2023 г. № 1370-ст

НАЦИОНАЛЬНЫЙ СТАНДАРТ РОССИЙСКОЙ ФЕДЕРАЦИИ

БЛОКИ СЛОЖНО-ФУНКЦИОНАЛЬНЫЕ

РУКОВОДСТВО ПО ПРОГРАММИРОВАНИЮ

IP cores. Programming guide

ГОСТ Р 71087-2023

ОКС 31.190

Дата введения

1 января 2024 года

Предисловие

1 РАЗРАБОТАН Акционерным обществом «Научно-производственное предприятие „Цифровые решения“ (АО „НПП „Цифровые решения“)»

2 ВНЕСЕН Техническим комитетом по стандартизации ТК 303 «Электронная компонентная база, материалы и оборудование»

3 УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Приказом Федерального агентства по техническому регулированию и метрологии от 9 ноября 2023 г. № 1370-ст

4 ВВЕДЕН ВПЕРВЫЕ

Правила применения настоящего стандарта установлены в статье 26 Федерального закона от 29 июня 2015 г. № 162-ФЗ «О стандартизации в Российской Федерации». Информация об изменениях к настоящему стандарту публикуется в ежегодном (по состоянию на 1 января текущего года) информационном указателе «Национальные стандарты», а официальный текст изменений и поправок — в ежемесячном информационном указателе «Национальные стандарты». В случае пересмотра (замены) или отмены настоящего стандарта соответствующее уведомление будет опубликовано в ближайшем выпуске ежемесячного информационного указателя «Национальные стандарты». Соответствующая информация, уведомление и тексты размещаются также в информационной системе общего пользования — на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет (www.rst.gov.ru)

1 Область применения

Настоящий стандарт распространяется на сложно-функциональные блоки (далее — СФ-блоки), применяемые при разработке интегральных микросхем.

Настоящий стандарт устанавливает требования к построению, содержанию, изложению и оформлению руководства по программированию СФ-блока.

При необходимости требования, установленные в настоящем стандарте, могут быть конкретизированы в стандартах и/или иных документах разработчика СФ-блока.

2 Нормативные ссылки

В настоящем стандарте использованы нормативные ссылки на следующие стандарты:

ГОСТ 2.701 Единая система конструкторской документации. Схемы. Виды и типы. Общие требования к выполнению

ГОСТ Р 2.105 Единая система конструкторской документации. Общие требования к текстовым документам

ГОСТ Р 55386 Интеллектуальная собственность. Термины и определения

ГОСТ Р 57435 Микросхемы интегральные. Термины и определения

ГОСТ Р 70916 Блоки сложно-функциональные. Термины и определения

Примечание - При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов в информационной системе общего пользования — на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет или по ежегодному информационному указателю «Национальные стандарты», который опубликован по состоянию на 1 января текущего года, и по выпускам ежемесячного информационного указателя «Национальные стандарты» за текущий год. Если заменен ссылочный стандарт, на который дана недатированная ссылка, то рекомендуется использовать действующую версию этого стандарта с учетом всех внесенных в данную версию изменений. Если заменен ссылочный стандарт, на который дана датированная ссылка, то рекомендуется использовать версию этого стандарта с указанным выше годом утверждения (принятия). Если после утверждения настоящего стандарта в ссылочный стандарт, на который дана датированная ссылка, внесено изменение, затрагивающее положение, на которое дана ссылка, то это положение рекомендуется применять без учета данного изменения. Если ссылочный стандарт отменен без замены, то положение, в котором дана ссылка на него, рекомендуется применять в части, не затрагивающей эту ссылку.

3 Термины и определения

В настоящем стандарте применены термины по ГОСТ 2.701, ГОСТ Р 55386, ГОСТ Р 57435, ГОСТ Р 70916, а также следующие термины с соответствующими определениями:

3.1 (битовое) поле: Абстрактное представление аппаратного элемента хранения данных.

3.2 регистр: Набор из одного или более битовых полей.

4 Общие положения

4.1 Руководство по программированию является документом, содержащим сведения о взаимодействии СФ-блока с программным обеспечением.

4.2 Руководство по программированию следует разрабатывать на один конкретный СФ-блок или на множество однотипных СФ-блоков.

4.3 В руководстве по программированию требования, приведенные в соответствующих межгосударственных и национальных стандартах, повторять не следует, данные требования заменяют ссылками на эти стандарты.

4.4 Общее оформление титульного листа, заголовков, текста, приложений, перечислений, таблиц, графического материала, формул, ссылок, примечаний, примеров, единиц величин и числовых значений рекомендуется выполнять согласно требованиям ГОСТ Р 2.105.

4.5 Руководство по программированию может быть выполнено в бумажной и/или электронной форме (на бумажных и/или электронных носителях).

4.6 В руководстве по программированию не допускается двусмысленность информации, а именно:

руководство по программированию должно быть сформулировано точно и понятно для квалифицированного персонала;
последовательность выполняемых действий должна быть однозначной;
риски и запреты должны быть точно сформулированы и изложены.

4.7 Если для СФ-блока неприменима операция программирования, руководство по программированию в комплект документации на СФ-блок не включают.

5 Построение и изложение руководства по программированию

5.1 Общая структура руководства по программированию

5.1.1 Руководство по программированию должно содержать введение и разделы, расположенные в следующей последовательности:

карта регистров;
описание регистров;
инструкция по программированию.

5.1.1.1 При необходимости руководство по программированию может быть дополнено другими разделами (подразделами), в зависимости от типа и особенностей СФ-блока.

5.1.1.2 Если карты регистров составляются на группы (блоки) регистров, описание регистров соответствующей группы (блока) рекомендуется приводить непосредственно после их карты. В этом случае вместо разделов «Карта регистров» и «Описание регистров» вводятся разделы «Карта регистров группы (блока) ...» и «Описание регистров группы (блока) ...».

5.1.1.3 Отсутствие требований, ограничений или рекомендаций ввиду особенностей СФ-блока должно быть явно и однозначно отражено в содержании раздела (подраздела).

5.1.1.4 Допускается в наименованиях разделов (подразделов) заменять сокращение «СФ-блок» на наименование СФ-блока.

5.1.2 Допускается включать руководство по программированию в состав руководства пользователя СФ-блока в качестве дополнительного раздела в случае, если объем документа не превышает 20 страниц.

5.2 Введение

5.2.1 Допускается включать во введение информацию о разработчике СФ-блока.

5.2.2 Допускается включать во введение информацию о защите интеллектуальной собственности.

5.2.3 Рекомендуется включать во введение заявление об освобождении от ответственности в случае несоблюдения требований руководства по программированию.

5.3 Карта регистров

5.3.1 Раздел «Карта регистров» должен содержать перечень регистров, доступных программному обеспечению, и соответствующие регистрам адреса (абсолютные или смещения относительно базового адреса), а также краткие сведения о назначении регистров (описание).

5.3.1.1 Рекомендуется включать в раздел «Карта регистров» общие сведения о регистрах: ширина, тип доступа, тип интерфейса по которому осуществляется доступ.

5.3.2 Перечень регистров, краткие сведения о назначении регистров и соответствующие регистрам адреса следует приводить как показано в таблице 1.

Таблица 1

Адрес	Наименование	Описание
0xFFFFA000	WdogLoad	Регистр загрузки
0xFFFFA002	WdogValue	Регистр значения счетчика
0xFFFFA004	WdogControl	Регистр управления
0xFFFFA006	WdogIntClr	Регистр сброса прерываний
0xFFFFA008	WdogRIS	Регистр состояния прерывания до наложения маски
0xFFFFA00A	WdogMIS	Регистр состояния прерывания после наложения маски
0xFFFFA100	WdogLock	Регистр блокировки записи

5.3.3 При необходимости, в зависимости от типа и особенностей СФ-блока, в таблицу допускается вводить дополнительные графы перед графой «Описание».

5.4 Описание регистров

5.4.1 Раздел «Описание регистров» должен содержать описание всех регистров СФ-блока, взаимодействующих с программным обеспечением.

5.4.1.1 Сведения о регистре СФ-блока должны содержать название регистра, адрес, поля (номера битов), названия полей, тип доступа, значения после сброса и описание.

5.4.1.2 Допускается группировать описания регистров СФ-блока.

5.4.2 Описание регистра WdogControl 0x00001200 СФ-блока следует приводить в соответствии с таблицей 2.

Таблица 2

Поле	Наименование	Тип доступа	Значение после сброса	Описание
31:8	-	-	-	Зарезервировано
7:6	TRAS	ЧЗ	0x0	Минимальное время, в течение которого строка памяти типа SDRAM должна быть открыта: 0b101 — 4 такта; 0b100 — 5 тактов; 0b011 — 6 тактов; 0b010 — 7 тактов; 0b001 — 8 тактов; 0b000 — 9 тактов; 0b111 — 10 тактов; 0b110 — 11 тактов
5:4	TRCD	ЧЗ	0x0	Задержка выдачи сигнала CAS относительно RAS: 0b11 — 2 такта; 0b10 — 3 такта; 0b01 — 4 такта; 0b00 — 5 тактов
3	SI	ЧЗ	0x0	Задание параметров памяти типа SDRAM (инициализация SDRAM): 0b0 — осуществляется внешним образом; 0b1 — производит процессор
2	TRDL	ЧЗ	0x0	Задержка на закрытие строки после записи SDRAM: 0b0 — 1 такт; 0b1 — 2 такта
1:0	CL	ЧЗ	0x0	Cas Lattency при обращении к памяти типа SDRAM: 0b00 — CL = 3 такта; 0b01 — CL = 2 такта; 0b10 — CL = 1 такт; 0b11 — резерв

5.4.2.1 Поля в описании регистра должны идти от старшего бита к младшему.

5.4.2.2 Для заполнения поля «Тип доступа» вводят следующие обозначения наименований базовых операций и префиксов к ним:

Ч — чтение;
З — запись;
0 — читается/записывается только 0;
1 — читается/записывается только 1;
С — во время операции выполняется сброс значения;
А — выполняется автоматический сброс значения аппаратной частью.

Примечание - Возможна комбинация разных режимов чтения и записи.

Примеры

1 ЧС — только чтение регистра с одновременным сбросом значения, запись игнорируется.

2 ЧЗ — чтение/запись регистра.

3 ЧЗ1С — чтение/запись 1 сбрасывает значение (если читаемое значение 1 — произошло событие, запись 1 сбрасывает значение регистра в 0).

4 ЧЗ1А — чтение/запись только 1 с автоматическим сбросом по завершении (запись 1 запускает выполнение функции, чтение возвращает 1 в процессе выполнения, по ее окончании значение сбрасывается в 0).

5.4.2.3 К шестнадцатеричным значениям следует добавлять префикс 0x, к бинарным значениям добавлять префикс 0b, к десятичным значениям префикс не добавляется.

5.4.2.4 Расширенную информацию, дополнительные расшифровки и примечания к описанию работы регистров рекомендуется приводить в сносках после таблицы с описанием регистров.

5.4.3 При необходимости в зависимости от типа и особенностей СФ-блока в таблицу допускается вводить дополнительные графы перед графой «Описание».

5.5 Инструкция по программированию

5.5.1 Раздел «Инструкция по программированию» должен содержать описание процедур программирования СФ-блока для выполнения функционала, описанного в руководстве пользователя.

5.5.1.1 Раздел должен содержать описание поддерживаемых СФ-блоком режимов работы и описание процедур программирования для изменения режимов работы СФ-блока.

5.5.1.2 Раздел должен содержать описание процедур программирования регистров СФ-блока.

5.5.1.3 Допускается приводить в разделе алгоритмические блок-схемы, временные диаграммы и структурные электрические схемы для описания процедур программирования.

5.5.1.4 Раздел дополнительно может содержать описание программной части тестового окружения, входящего в комплект поставки СФ-блока.

УДК 621.382:006.354	ОКС 31.190
Ключевые слова: сложно-функциональные блоки, СФ-блоки, программирование, руководство по программированию, регистры, описание регистров